CRichEditCtx Class

Provides the functionality of the rich edit control.

A “rich edit control” is a window in which the user can enter and edit text. The text can be assigned character and paragraph formatting, and can include embedded OLE objects. Rich edit controls provide a programming interface for formatting text. However, an application must implement any user interface components necessary to make formatting operations available to the user.

Methods inherited from CTextObjectBase

CRichEditCtx Properties

CRichEditCtx Methods

CRichEditCtx File Operations Methods

ITextDocument2 Methods and Properties

AfxCRichEditCtxPtr

Overloaded function that retrieves a pointer to the CRichEditCtxclass from the handle of the rich edit control or from the handle of its parent window and the control’s identifier.

FUNCTION AfxCRichEditCtxPtr OVERLOAD (BYVAL hRichEdit AS HWND) AS CRichEditCtx PTR
FUNCTION AfxCRichEditCtxPtr OVERLOAD (BYVAL hParent AS HWND, BYVAL cID AS LONG) AS CRichEditCtx PTR

Return value

A pointer to the CRichEditCtx class.

CONSTRUCTOR

Creates an instance of the rich edit control.

CONSTRUCTOR CRichEditCtx (BYVAL pWindow AS CWindow PTR, BYVAL cID AS LONG_PTR, BYREF wszTitle AS WSTRING = "", _
   BYVAL x AS LONG = 0, BYVAL y AS LONG = 0, BYVAL nWidth AS LONG = 0, BYVAL nHeight AS LONG = 0, _
   BYVAL dwStyle AS DWORD = 0, BYVAL dwExStyle AS DWORD = 0, BYVAL lpParam AS LONG_PTR = 0)

Usage example (dotted syntax)

DIM pRichEdit AS CRichEditCtx = CRichEditCtx(@pWindow, IDC_RICHEDIT, _
    "Rich Edit box", 100, 50, 300, 200)

Usage example (pointer syntax)

DIM pRichEdit AS CRichEditCtx PTR = NEW CRichEditCtx(@pWindow, IDC_RICHEDIT, _
    "Rich Edit box", 100, 50, 300, 200)

DESTRUCTOR

Called automatically when a class variable goes out of scope or is destroyed.

DESTRUCTOR CRichEditCtx

hRichEdit

Returns the handle of the rich edit control.

FUNCTION hRichEdit () AS HWND

Usage example

' // Create an instance of the CRichEditCtx class
DIM pRichEdit AS CRichEditCtx = CRichEditCtx(@pWindow, IDC_RICHEDIT, "RichEditbox", 100, 50, 300, 200)
' // Set the focus in the control
DIM hRichEdit AS HWND = pRichEdit.hRichEdit

ScalingRatio

Gets/sets the scaling ratio.

(GET) PROPERTY ScalingRatio () AS SINGLE
(SET) PROPERTY ScalingRatio (BYVAL Ratio AS SINGLE)

FUNCTION GetScalingRatio () AS SINGLE
SUB SetScalingRatio (BYVAL ratio AS SINGLE)

Remarks

The scaling ratio is used by the InsertImage and InsertObject methods to scale images according to the DPI settings of your computer. Its initial value is the scaling ratio used by its parent window, but you can change it with this property. Setting a value or 1 disables scaling.

Usage examples

DIM ratio AS LONG = pRichEdit.ScalingRatio
pRichEdit.ScalingRatio = ratio

DIM ratio AS LONG = pRichEdit.GetScalingRatio
pRichEdit.SetScalingRatio(ratio)

SetWysiwygPrint

Sets the target printer device and line width used for “what you see is what you get” (WYSIWYG) formatting in a rich edit control.

FUNCTION SetWysiwygPrint (BYREF wszPrinterName AS WSTRING = "") AS BOOLEAN

Return value

A boolean true (-1) or false (0).

RestoreTargetDevice

Sets the target device to the device context of the rich edit control.

FUNCTION RestoreTargetDevice () AS BOOLEAN

Return value

A boolean true (-1) or false (0).

AutoCorrectProc

Gets/sets a pointer to the application-defined AutoCorrectProc callback function.

(GET) PROPERTY AutoCorrectProc () AS LONG_PTR
(SET) PROPERTY AutoCorrectProc (BYVAL pfn AS LONG_PTR)

FUNCTION GetAutoCorrectProc () AS LONG_PTR
FUNCTION SetAutoCorrectProc (BYVAL pfn AS LONG_PTR) AS HRESULT

Return value

(GET) A pointer to the application-defined AutoCorrectProc callback function.

(SET) If the operation succeeds, the return value is zero. If the operation fails, the return value is a nonzero value.

AutoUrlDetect

Gets/sets whether the auto URL detection is turned on in the rich edit control.

(GET) PROPERTY AutoUrlDetect () AS BOOLEAN
(SET) PROPERTY AutoUrlDetect (BYVAL fUrlDetect AS LONG)

FUNCTION GetAutoUrlDetect () AS BOOLEAN
FUNCTION SetAutoUrlDetect (BYVAL fUrlDetect AS LONG) AS HRESULT

FUNCTION DisableAutoUrlDetect () AS BOOLEAN
FUNCTION EnableAutoUrlDetect (BYVAL fUrlDetect AS LONG) AS HRESULT

Return value

(GET) If auto-URL detection is active, the return value is true (-1). If auto-URL detection is inactive, the return value is false (0).

(SET) If the message succeeds, the return value is zero. If the message fails, the return value is a nonzero value. For example, the message might fail due to insufficient memory or an invalid detection option.

Remarks

If automatic URL detection is enabled (that is, fUrlDetect includes AURL_ENABLEURL), the rich edit control scans any modified text to determine whether the text matches the format of a URL (or more generally in Windows 8 or later an IRI International Resource Identifier). The control detects URLs that begin with the following scheme names:

• callto
• file
• ftp
• gopher
• http
• https
• mailto
• news
• notes
• nntp
• onenote
• outlook
• prospero
• tel
• telnet
• wais
• webcal

When automatic link detection is enabled, the rich edit control removes the CFE_LINK effect from modified text that does not have a format recognized by the control. If your application uses the CFE_LINK effect to mark other types of text, do not enable automatic link detection. The rich edit control does not check whether a detected link exists; that responsibility belongs to the client.

A rich edit control sends the EN_LINK notification when it receives various messages while the mouse pointer is over text that has the CFE_LINK effect.

BidiOptions

Gets/sets the current state of the bidirectional options in the rich edit control.

(GET) PROPERTY BidiOptions () AS .BIDIOPTIONS
(SET) PROPERTY BidiOptions (BYREF opt AS .BIDIOPTIONS)

FUNCTION GetBidiOptions () AS .BIDIOPTIONS
SUB SetBidiOptions (BYREF opt AS .BIDIOPTIONS)

Return value

(GET) A BIDIOPTIONS structure with the current state of the bidirectional options in the rich edit control. The values of the wMask and wEffects contain the current state of the bidirectional options in the rich edit control.

(SET) This property does not return a result.

Remarks (SET property)

The rich edit control must be in plain text mode or BidiOptions will not do anything.

In plain text controls, BidiOptions automatically determines the paragraph direction and/or alignment based on the context rules. These rules state that the direction and/or alignment is derived from the first strong character in the control. A strong character is one from which text direction can be determined (see Unicode Standard version 2.0). The paragraph direction and/or alignment is applied to the default format.

BidiOptions only switches the default paragraph format to RTL (right to left) if it finds an RTL character.

CaretPos

Gets/sets the caret position.

(GET) PROPERTY CaretPos () AS DWORD
(SET) PROPERTY CaretPos (BYVAL dwPos AS DWORD)

FUNCTION GetCaretPos () AS DWORD
SUB SetCaretPos (BYVAL dwPos AS DWORD)

Return value

(GET) The caret position.

(SET) This property does not return a result.

CharFormat

Gets/sets the current character formatting in a rich edit control.

(GET) PROPERTY CharFormat (BYVAL fOption AS DWORD) AS CHARFORMATW
(SET) PROPERTY CharFormat (BYVAL chfmt AS DWORD, BYREF cf AS CHARFORMATW)

FUNCTION GetCharFormat (BYVAL fOption AS DWORD) AS CHARFORMATW
FUNCTION SetCharFormat (BYVAL chfmt AS DWORD, BYREF cf AS CHARFORMATW) AS BOOLEAN

Gets/sets the default character formatting in a rich edit control.

(GET) PROPERTY DefaultCharFormat () AS CHARFORMATW
(SET) PROPERTY DefaultCharFormat (BYREF cf AS CHARFORMATW)

FUNCTION GetDefaultCharFormat () AS CHARFORMATW
FUNCTION SetDefaultCharFormat (BYREF cf AS CHARFORMATW) AS BOOLEAN

Gets/sets the character formatting attributes of the current selection.

(GET) PROPERTY SelectionCharFormat () AS CHARFORMATW
(SET) PROPERTY SelectionCharFormat (BYREF cf AS CHARFORMATW)

FUNCTION GetSelectionCharFormat () AS CHARFORMATW
FUNCTION SetSelectionCharFormat (BYREF cf AS CHARFORMATW) AS BOOLEAN

Gets/sets the character formatting attributes for the currently selected word.

(GET) PROPERTY WordCharFormat () AS CHARFORMATW
(SET) PROPERTY WordCharFormat (BYREF cf AS CHARFORMATW)

FUNCTION GetWordCharFormat () AS CHARFORMATW
FUNCTION SetWordCharFormat (BYREF cf AS CHARFORMATW) AS BOOLEAN

Return value

(GET) Returns a CHARFORMATW structure with the attributes of the first character. The dwMask member specifies which attributes are consistent throughout the entire selection. For example, if the entire selection is either in italics or not in italics, CFM_ITALIC is set; if the selection is partly in italics and partly not, CFM_ITALIC is not set.

(SET) If the operation succeeds, the return value is a nonzero value. If the operation fails, the return value is zero. Call GetErrorInfo to get information about the result.

Usage examples

Select text and change color

pRichEdit.ExSetSel(98, 113)         ' // Select word at position 98, 113
DIM cf AS CHARFORMAT
cf.dwMask = CFM_COLOR               ' // Let's set the color
cf.crTextColor = BGR(255, 0, 0)     ' // Red color
pRichEdit.SelectionCharFormat = cf  ' // Set the color
pRichEdit.HideSelection(TRUE)       ' // Hide selection

Select text and make it bold

pRichEdit.ExSetSel(98, 113)         ' // Select word at position 98, 113
DIM cf AS CHARFORMAT
cf.dwMask = CFM_BOLD                ' // The CFE_BOLD value of the dwEffects member is valid.
cf.dwEffects = CFE_BOLD             ' // Characters are bold
pRichEdit.SelectionCharFormat = cf  ' // Set the format
pRichEdit.HideSelection(TRUE)       ' // Hide selection

Select text and change the font height

pRichEdit.ExSetSel(98, 113)          ' // Select word at position 98, 113
DIM cf AS CHARFORMAT
cf.dwMask = CFM_SIZE                 ' // The yHeight member is valid.
cf.yHeight = 12 * 20                 ' // Character height, in twips (1/1440 of an inch or 1/20 of a printer's point)
pRichEdit.SelectionCharFormat = cf   ' // Set the format
pRichEdit.HideSelection(TRUE)        ' // Hide selection

CTFModeBias

Gets/sets the Text Services Framework mode bias values for a Microsoft Rich Edit control.

(GET) PROPERTY CTFModeBias () AS LONG
(SET) PROPERTY CTFModeBias (BYVAL nModeBias AS LONG)

FUNCTION GetCTFModeBias () AS LONG
FUNCTION SetCTFModeBias (BYVAL nModeBias AS LONG) AS HRESULT

Return value

(GET) The current Text Services Framework mode bias value.

(SET) If successful, the return value is the new TSF mode bias value. If unsuccessful, the return value is the old TSF mode bias value.

Remarks

When a Microsoft Rich Edit application uses TSF, it can select the TSF mode bias. This message sets the criteria by which an alternative choice appears at the top of the list for selection.

CTFOpenStatus

Gets/sets if the Text Services Framework (TSF) keyboard is open or closed.

(GET) PROPERTY CTFOpenStatus () AS BOOLEAN
(SET) PROPERTY CTFOpenStatus (BYVAL fTSFkbd AS LONG)

FUNCTION GetCTFOpenStatus () AS BOOLEAN
FUNCTION SetCTFOpenStatus (BYVAL fTSFkbd AS LONG) AS BOOLEAN

Return value

(GET) If the TSF keyboard is open, the return value is TRUE. Otherwise, it is FALSE.

(SET) If successful, it returns TRUE. If unsuccessful, it returns FALSE. Call the (GET) CTFOpenStatus property to check if the value has changed.

EditStyle

Gets/sets the current edit style flags.

(GET) PROPERTY EditStyle () AS DWORD
(SET) PROPERTY EditStyle (BYVAL fStyle AS LONG, BYVAL fMask AS LONG)

FUNCTION GetEditStyle () AS DWORD
FUNCTION SetEditStyle (BYVAL fStyle AS LONG, BYVAL fMask AS LONG) AS HRESULT

Return value

(GET) Returns the current edit style flags, which can include one or more of the following values (see table above).

(SET) The return value is the state of the edit style flags after the rich edit control has attempted to implement your edit style changes. The edit style flags are a set of flags that indicate the current edit style. Call the (GET) EditStyle property to check if the value has changed.

EditStyleEx

Gets/sets the extended edit style flags.

(GET) PROPERTY EditStyleEx () AS DWORD
(SET) PROPERTY EditStyleEx (BYVAL fStyle AS LONG, BYVAL fMask AS LONG)

FUNCTION GetEditStyleEx () AS DWORD
FUNCTION SetEditStyleEx (BYVAL fStyle AS LONG, BYVAL fMask AS LONG) AS HRESULT

Return value

(GET) Returns the state of the edit style flags.

(SET) The return value is the state of the edit style flags after the rich edit control has attempted to implement your edit style changes. The edit style flags are a set of flags that indicate the current edit style. Call the (GET) EditStyleEx property to check if the value has changed.

EllipsisMode

Gets/sets the current ellipsis mode. When enabled, an ellipsis ( ) is displayed for text that doesn’t fit in the display window. The ellipsis is only used when the control isn’t active. When active, scroll bars are used to reveal text that doesn’t fit into the display window.

(GET) PROPERTY EllipsisMode () AS DWORD
(SET) PROPERTY EllipsisMode (BYVAL fMode AS DWORD)

FUNCTION GetEllipsisMode () AS DWORD
FUNCTION SetEllipsisMode (BYVAL fMode AS DWORD) AS BOOLEAN

The bits for these values all fit in the ELLIPSIS_MASK.

Return value

A boolean true(-1) or false (0).

EllipsisState

Gets the current ellipsis state.

PROPERTY EllipsisState () AS BOOLEAN
FUNCTION GetEllipsisState () AS BOOLEAN

Return value

Returns a boolean true (-1) if an ellipsis is being displayed of false (0) otherwise.

EventMask

Gets/sets the event mask for a rich edit control. The event mask specifies which notification messages the control sends to its parent window.

(GET) PROPERTY EventMask () AS DWORD
(SET) PROPERTY EventMask (BYVAL fMask AS DWORD)

FUNCTION GetEventMask () AS DWORD
FUNCTION SetEventMask (BYVAL fMask AS DWORD) AS HRESULT

Return value

(GET) The event mask for this rich edit control.

(SET) Returns the previous event mask. Call the (GET) EventMask property to check if the value has changed.

Remarks

The default event mask is ENM_NONE in which case no notifications are sent to the parent window.

FirstVisibleLine

Gets the zero-based index of the uppermost visible line in a multiline rich edit control.

PROPERTY FirstVisibleLine () AS LONG
FUNCTION GetFirstVisibleLine () AS LONG

Return value

The return value is the zero-based index of the uppermost visible line in a multiline edit control.

For single-line rich edit controls, the return value is zero.

HyphenateInfo

Gets/sets information about hyphenation for a Microsoft Rich Edit control.

(GET) PROPERTY HyphenateInfo () AS .HYPHENATEINFO
(SET) PROPERTY HyphenateInfo (BYREF hinfo AS .HYPHENATEINFO)

FUNCTION GetHyphenateInfo () AS .HYPHENATEINFO
FUNCTION SetHyphenateInfo (BYREF info AS .HYPHENATEINFO) AS HRESULT

Return value

(GET) A HYPHENATEINFO structure.

IMEModeBias

Gets/sets the Input Method Editor (IME) mode bias for a Microsoft Rich Edit control.

PROPERTY IMEModeBias () AS DWORD
PROPERTY IMEModeBias (BYVAL nModeBias AS LONG)

FUNCTION GetIMEModeBias () AS DWORD
FUNCTION SetIMEModeBias (BYVAL nModeBias AS LONG) AS HRESULT

Return value

(GET) This message returns the current IME mode bias setting.

(SET) If successful, the return value is the new TSF mode bias value. If unsuccessful, the return value is the old TSF mode bias value. Call the (GET) IMEModeBias property to check if the value has changed.

Remarks

(GET) To get the Text Services Framework mode bias, use the CTFModeBias property.

(SET) When a Microsoft Rich Edit application uses TSF, it can select the TSF mode bias. This message sets the criteria by which an alternative choice appears at the top of the list for selection.

The application should call the IsIME method before calling these properties.

IMEOptions

Gets/sets the current Input Method Editor (IME) options. This message is available only in Asian-language versions of the operating system.

(GET) PROPERTY IMEOptions () AS DWORD
(SET) PROPERTY IMEOptions (BYVAL fCoop AS LONG, BYVAL fOptions AS LONG)

FUNCTION GetIMEOptions () AS DWORD
FUNCTION SetIMEOptions (BYVAL fCoop AS LONG, BYVAL fOptions AS LONG) AS HRESULT

Return value

(GET) Returns one or more of the IME option flag values described in the fOptions parameter of the SET property.

(SET) If the operation succeeds, the return value is a nonzero value. If the operation fails, the return value is zero. Call the (GET) ImeOptions property to check if the value has changed.

LangOptions

Gets/sets a rich edit control’s option settings for Input Method Editor (IME) and Asian language support.

(GET) PROPERTY LangOptions () AS DWORD
(SET) PROPERTY LangOptions (BYVAL lgoptions AS LONG)

FUNCTION GetLangOptions () AS DWORD
FUNCTION SetLangOptions (BYVAL lgoptions AS LONG) AS HRESULT

Return value

(GET) Returns the IME and Asian language settings, which can be zero or more of the above flags.

(SET) Returns a value of 1. Call the (GET) LangOptions property to check the value.

Remarks

The IMF_AUTOFONT flag is set by default. The IMF_AUTOKEYBOARD and IMF_IMECANCELCOMPLETE flags are cleared by default.

LimitText

Gets/sets the current text limit for a rich edit control. The text limit is the maximum amount of text that the user can type into the edit control.

(GET) PROPERTY LimitText () AS LONG
(SET) PROPERTY LimitText (BYVAL chMax AS DWORD)

Return value

(GET) The return value is the text limit.

(SET) The set property does not return a value.

Remarks

(SET) LimitText limits only the text the user can enter. It does not affect any text already in the edit control when the message is sent, nor does it affect the length of the text copied to the edit control by the Text property. If an application uses the Text property to place more text into an edit control than is specified by the LimitText property, the user can edit the entire contents of the edit control.

GetLimitText

Gets the current text limit for a rich edit control. The text limit is the maximum amount of text that the user can type into the edit control.

FUNCTION GetLimitText () AS LONG

Return value

The return value is the text limit.

SetLimitText

Sets the current text limit for a rich edit control. The text limit is the maximum amount of text that the user can type into the edit control.

SUB SetLimitText (BYVAL chMax AS DWORD)

Return value

The set property does not return a value.

Remarks

SetLimitText limits only the text the user can enter. It does not affect any text already in the edit control when the message is sent, nor does it affect the length of the text copied to the edit control by the SetText method. If an application uses the SetText method to place more text into an edit control than is specified by the SetLimitText method, the user can edit the entire contents of the edit control.

Modify

Gets/sets the state of a rich edit control’s modification flag. The flag indicates whether the contents of the rich edit control have been modified.

(GET) PROPERTY Modify () AS LONG
(SET) PROPERTY Modify (BYVAL fModify AS LONG)

FUNCTION GetModify () AS LONG
SUB SetModify (BYVAL fModify AS LONG)

FUNCTION IsModified () AS BOOLEAN

Return value

(GET) If the contents of edit control have been modified, the return value is nonzero; otherwise, it is zero.

(SET) The set property does not return a value.

Remarks

The system automatically clears the modification flag to zero when the control is created. If the user changes the control’s text, the system sets the flag to nonzero. You can use the (SET) Modify property to set or clear the flag.

Options

Gets/sets the options for a rich edit control.

(GET) PROPERTY Options () AS DWORD
(SET) PROPERTY Options (BYVAL fCoop AS LONG, BYVAL fOptions AS LONG)

FUNCTION GetOptions () AS DWORD
FUNCTION SetOptions (BYVAL fCoop AS LONG, BYVAL fOptions AS LONG) AS DWORD

Return value

(GET) This message returns a combination of the current option flag values described in the fOptions parameter of the (SET) Options property.

(SET) This message returns the current options of the edit control. Call the (GET) Options property to get the values.

PageRotate

Deprecated. Gets/sets the text layout for a Microsoft Rich Edit control.

(GET) PROPERTY PageRotate () AS DWORD
(SET) PROPERTY PageRotate (BYVAL txtlayout AS LONG)

FUNCTION GetPageRotate () AS DWORD
FUNCTION SetPageRotate (BYVAL txtlayout AS LONG) AS DWORD

Return value

(GET) The current text layout. For a list of possible text layout values, see the txtlayout parameter above.

(SET) Return value is the new text layout value. Call the (GET) PageRotate property to get the value.

Remarks

(SET) This message sets the text layout for the entire document. However, embedded contents are not rotated and must be rotated separately by the application.

ParaFormat

Gets/sets the paragraph formatting of the current selection in a rich edit control.

(GET) PROPERTY ParaFormat () AS .PARAFORMAT
(SET) PROPERTY ParaFormat (BYREF pfmt AS .PARAFORMAT)

FUNCTION GetParaFormat () AS .PARAFORMAT
FUNCTION SetParaFormat (BYREF pfmt AS .PARAFORMAT) AS BOOLEAN

Return value

(GET) Returns a PARAFORMAT structure.

(SET) If the operation succeeds, the return value is a nonzero value. If the operation fails, the return value is zero.

PasswordChar

Gets/sets the password character that a rich edit control displays when the user enters text.

(GET) PROPERTY PasswordChar () AS LONG
(SET) PROPERTY PasswordChar (BYVAL dwchar AS DWORD)

FUNCTION GetPasswordChar () AS LONG
FUNCTION SetPasswordChar (BYVAL dwchar AS DWORD)

Return value

(GET) The return value specifies the character to be displayed in place of any characters typed by the user. If the return value is NULL, there is no password character, and the control displays the characters typed by the user.

(SET) The set property does not return a value.

Remarks

When an edit control receives the EM_SETPASSWORDCHAR message, the control redraws all visible characters using the character specified by the dwchar parameter. If dwchar is zero, the control redraws all visible characters using the characters typed by the user.

If an edit control is created with the ES_PASSWORD style, the default password character is set to an asterisk (). If an edit control is created without the ES_PASSWORD style, there is no password character. The ES_PASSWORD style is removed if an EM_SETPASSWORDCHAR is sent with the dwchar* parameter set to zero.

Edit controls: Multiline edit controls do not support the password style or messages.

Punctuation

Gets/sets the current punctuation characters for the rich edit control.

(GET) PROPERTY Punctuation (BYVAL punctype AS DWORD) AS .PUNCTUATION
(SET) PROPERTY Punctuation (BYVAL punctype AS LONG, BYREF punct AS .PUNCTUATION)

FUNCTION GetPunctuation (BYVAL punctype AS DWORD) AS .PUNCTUATION
FUNCTION SetPunctuation (BYVAL punctype AS LONG, BYREF punct AS .PUNCTUATION) AS BOOLEAN

Return value

If the operation succeeds, the return value is a nonzero value. If the operation fails, the return value is zero.

Note

This message is supported only in Asian-language versions of Microsoft Rich Edit 1.0. It is not supported in any later versions.

Rect

Gets/sets the formatting rectangle of a rich edit control.

(GET) PROPERTY Rect () AS .RECT
(SET) PROPERTY Rect (BYVAL fCoord AS LONG, BYREF rc AS .RECT)

FUNCTION GetRect () AS .RECT
SUB SetRect (BYVAL fCoord AS LONG, BYREF rc AS .RECT)

Return value

(GET) A RECT structure with the formatting rectangle.

(SET) The set property does not return a value.

Remarks

Setting rc to NULL has no effect if a touch device is installed, or if the message is sent from a thread that has a hook installed (see SetWindowsHookEx). In these cases, rc should contain a valid pointer to a RECT structure.

The (SET) Rect property causes the text of the rich edit control to be redrawn. To change the size of the formatting rectangle without redrawing the text, use the RectNP property.

When a rich edit control is first created, the formatting rectangle is set to a default size. You can use the (SET) Rect message to make the formatting rectangle larger or smaller than the rich edit control window.

If the rich edit control does not have a horizontal scroll bar, and the formatting rectangle is set to be larger than the rich edit control window, lines of text exceeding the width of the rich edit control window (but smaller than the width of the formatting rectangle) are clipped instead of wrapped.

If the rich edit control contains a border, the formatting rectangle is reduced by the size of the border. If you are adjusting the rectangle returned by the (GET) Rect property, you must remove the size of the border before using the rectangle with the (SET) Rect property.

The formatting rectangle does not include the selection bar, which is an unmarked area to the left of each paragraph. When the user clicks in the selection bar, the corresponding line is selected.

RectNP

Sets the formatting rectangle of a multiline rich edit control. It is identical to the Rect property, except that RectNP does not redraw the edit control window.

The formatting rectangle is the limiting rectangle into which the control draws the text. The limiting rectangle is independent of the size of the edit control window.

This message is processed only by multiline edit controls. You can send this message to either an edit control or a rich edit control.

(SET) PROPERTY RectNP (BYVAL fCoord AS LONG, BYREF rc AS .RECT)

SUB SetRectNP (BYVAL fCoord AS LONG, BYREF rc AS .RECT)

Return value

This property does not return a value.

RedoName

Retrieves the type of the next action, if any, in the control’s redo queue.

FUNCTION RedoName () AS LONG
FUNCTION GetRedoName () AS LONG

Return value

If the redo queue for the control is not empty, the value returned is an UNDONAMEID enumeration value that indicates the type of the next action in the control’s redo queue.

If there are no redoable actions or the type of the next redoable action is unknown, the return value is zero.

UNDONAMEID enumeration

Remarks

The types of actions that can be undone or redone include typing, delete, drag-drop, cut, and paste operations. This information can be useful for applications that provide an extended user interface for undo and redo operations, such as a drop-down list box of redoable actions.

ScrollPos

Gets/sets the current scroll position of the edit control.

(GET) PROPERTY ScrollPos () AS .POINT
(SET) PROPERTY ScrollPos (BYREF pt AS .POINT)

FUNCTION GetScrollPos () AS .POINT
FUNCTION SetScrollPos (BYREF pt AS .POINT) AS HRESULT

Return value

(GET) A POINT structure containing a point in the virtual text space of the document, expressed in pixels. This point will be the point that is currently located in the upper-left corner of the edit control window.

(SET) This message always returns 1.

Remarks

The values returned in the POINT structure are 16-bit values (even in the 32-bit wide fields).

StoryType

Gets/sets the story type.

PROPERTY StoryType (BYVAL Index AS DWORD) AS DWORD
PROPERTY StoryType (BYVAL Index AS LONG, BYVAL dwType AS DWORD)

FUNCTION GetStoryType (BYVAL Index AS DWORD) AS DWORD
FUNCTION SetStoryType (BYVAL Index AS LONG, BYVAL dwType AS DWORD) AS DWORD

Return value

(GET) Returns the story type, which can be a client-defined custom value, or one of the values listed in the table above.

(SET) The story type that was set. Call the (GET) StoryType property to get the value.

Text

Gets/sets the text from a rich edit control.

(GET) PROPERTY Text () AS DWSTRING
(SET) PROPERTY Text (BYREF wszText AS WSTRING)

FUNCTION GetText () AS DWSTRING
FUNCTION SetText (BYREF wszText AS WSTRING) AS BOOLEAN

Return value

(GET) The retrieved text.

(SET) The return value is TRUE if the text is set. Call GetErrorInfo to get information about the result.

Remarks

The Windows API function GetWindowTextW can also be used to retrieve the text of a rich edit control, but it cannot retrieve the text of a control in another application.

Usage example (GET)

DIM dws AS DWSTRING = pRichEdit.Text

Usage example (SET)

DIM dws AS DWSTRING = "New text"
pRichEdit.Text = dws

TextLength

Retrieves the length of all text in a rich edit control.

FUNCTION TextLength () AS LONG
FUNCTION GetTextLength () AS LONG

Return value

The return value is the length of the text in characters, not including the terminating null character.

Remarks

When the GetTextLength method is called, the DefWindowProc function returns the length, in characters, of the text. Under certain conditions, the DefWindowProc function returns a value that is larger than the actual length of the text. This occurs with certain mixtures of ANSI and Unicode, and is due to the system allowing for the possible existence of double-byte character set (DBCS) characters within the text. The return value, however, will always be at least as large as the actual length of the text; you can thus always use it to guide buffer allocation. This behavior can occur when an application uses both ANSI functions and common dialogs, which use Unicode.

To retrieve the text, you can also use the AfxGetWindowText function, the WM_GETTEXT message, or the Windows API GetWindowTextW function.

TextLengthEx

Calculates text length in various ways. It is usually called before creating a buffer to receive the text from the control. Since this CRichEditCtx class uses unicode, it is easier to use the simplified second overloaded function.

FUNCTION TextLengthEx (BYREF gtex AS .GETTEXTLENGTHEX) AS LONG
FUNCTION TextLengthEx (BYVAL dwFlags AS DWORD = GTL_DEFAULT) AS LONG
FUNCTION GetTextLengthEx OVERLOAD (BYREF gtex AS .GETTEXTLENGTHEX) AS LONG
FUNCTION GetTextLengthEx OVERLOAD (BYVAL dwFlags AS DWORD = GTL_DEFAULT) AS LONG

Return value

First overloaded method: The method returns the number of characters in the edit control, depending on the setting of the flags in the GETTEXTLENGTHEX structure. If incompatible flags were set in the flags member, the message returns E_INVALIDARG.

Second overloaded method: The method returns the number of characters in the edit control, depending on the setting of the flags in the dwFlags parameter. If incompatible flags were set in the flags member, the message returns E_INVALIDARG.

Remarks

This message is a fast and easy way to determine the number of characters in the Unicode version of the rich edit control. However, for a non-Unicode target code page you will potentially be converting to a combination of single-byte and double-byte characters.

Usage examples

--- First overloaded method:
DIM gtex AS GETTEXTLENGTHEX = TYPE<GETTEXTLENGTHEX>(GTL_NUMCHARS, 1200)
DIM Result AS LONG = pRichEdit.GetTextLEngthEx(gtex)
DIM cbLen AS LONG
IF Result <> E_INVALIDARG THEN cbLen = Result

--- Second overloaded method:
DIM Result AS LONG = pRichEdit.GetTextLEngthEx                 ' // Uses the GTL_DEFAULT flag
DIM Result AS LONG = pRichEdit.GetTextLEngthEx(GTL_NUMCHARS)   ' // Uses the GTL_NUMCHARS flag
DIM cbLen AS LONG
IF Result <> E_INVALIDARG THEN cbLen = Result

TextMode

Gets/sets the current text mode and undo level of a rich edit control.

(GET) PROPERTY TextMode () AS DWORD
(SET) PROPERTY TextMode (BYVAL values AS LONG)

FUNCTION GetTextMode () AS DWORD
FUNCTION SetTextMode (BYVAL values AS LONG) AS BOOLEAN

TextMode enumeration type

Specify one of the following values to set the text mode parameter. If you do not specify a text mode value, the text mode remains at its current setting.

Specify one of the following values to set the undo level parameter. If you do not specify an undo level value, the undo level remains at its current setting.

Specify one of the following values to set the code page parameter. If you do not specify an code page value, the code page remains at its current setting.

Return value

(GET) The return value is one or more values from the TEXTMODE enumeration type. The values indicate the current text mode and undo level of the control.

(SET) If the message succeeds, the result code is zero. If the message fails, the result code is a nonzero value.

Remarks

In rich text mode, a rich edit control has standard rich edit functionality. However, in plain text mode, the control is similar to a standard edit control:

• The text in a plain text control can have only one format (such as Bold, 10pt Arial).
• The user cannot paste rich text formats, such as Rich Text Format (RTF) or embedded objects into a plain text control.
• Rich text mode controls always have a default end-of-document marker or carriage return, to format paragraphs. Plain text controls, on the other hand, do not need the default, end-of-document marker, so it is omitted.
• The control must contain no text when it receives the EM_SETTEXTMODE message. To ensure there is no text, call the (SET) Text property with an empty string (““).

TouchOptions

Gets/sets the touch options that are associated with a rich edit control.

(GET) PROPERTY TouchOptions (BYVAL opt AS LONG PTR) AS DWORD
(SET) PROPERTY TouchOptions (BYVAL opt AS LONG, BYVAL fEnable AS LONG)

FUNCTION GetTouchOptions (BYVAL opt AS LONG PTR) AS DWORD
FUNCTION SetTouchOptions (BYVAL opt AS LONG, BYVAL fEnable AS LONG) AS HRESULT

Return value

(GET) Returns the value of the option specified by the opt parameter. It is nonzero if opt is RTO_SHOWHANDLES and the touch grippers are visible; zero, otherwise.

(SET) Returns TRUE if opt is valid, otherwise FALSE.

Remarks

Advanced line breaking is turned on automatically by the rich edit control when needed, such as for handling complex scripts like Arabic and Hebrew, and for mathematics. It s also needed for justified paragraphs, hyphenation, and other typographic features.

TypographyOptions

Gets/sets the current state of the typography options of a rich edit control.

(GET) PROPERTY TypographyOptions () AS DWORD
(SET) PROPERTY TypographyOptions (BYVAL pto AS LONG, BYVAL fMask AS LONG)

FUNCTION GetTypographyOptions () AS DWORD
FUNCTION SetTypographyOptions (BYVAL pto AS LONG, BYVAL fMask AS LONG) AS BOOLEAN

Return value

(GET) Returns the current typography options.

(SET) A boolean true (-1) or false (0).

Remarks

You can turn on advanced line breaking by sending calling the (SET) TypographyOPtions property. Advanced line breaking is turned on automatically by the rich edit control when needed, such as for handling complex scripts like Arabic and Hebrew, and for mathematics. It is also needed for justified paragraphs, hyphenation, and other typographic features.

EnableAdvancedTypography

Enables advanced typography.

FUNCTION EnableAdvancedTypography () AS BOOLEAN

Return value

A boolean true (-1) or false (0).

Remarks

Advanced typography is needed for justified paragraphs, hyphenation, and other typographic features. Advanced line breaking is turned on automatically by the rich edit control when needed, such as for handling complex scripts like Arabic and Hebrew, and for mathematics.

WordBreakProc

Gets/sets the address of the currently registered word-break procedure.

PROPERTY WordBreakProc () AS LONG_PTR
PROPERTY WordBreakProc (BYVAL pfn AS LONG_PTR)

FUNCTION GetWordBreakProc () AS LONG_PTR
SUB SetWordBreakProc (BYVAL pfn AS LONG_PTR)

Gets/sets the address of the currently registered extended word-break procedure.

PROPERTY WordBreakProcEx () AS LONG_PTR
PROPERTY WordBreakProcEx (BYVAL pfn AS LONG_PTR)

FUNCTION GetWordBreakProcEx () AS LONG_PTR
SUB SetWordBreakProcEx (BYVAL pfn AS LONG_PTR)

Return value

The return value specifies the address of the application-defined word-break function. The return value is NULL if no word-break function exists.

Remarks

A Wordwrap function scans a text buffer that contains text to be sent to the display, looking for the first word that does not fit on the current display line. The wordwrap function places this word at the beginning of the next line on the display. A Wordwrap function defines the point at which the system should break a line of text for multiline edit controls, usually at a space character that separates two words.

WordWrap

Enables/disables word wrap.

FUNCTION DisableWordWrap (BYVAL LineWidth AS LONG = 32767) AS BOOLEAN
FUNCTION EnableWordWrap () AS BOOLEAN

Return value

If the method succeeds it returns the boolean value true (-1); if it fails, it returns false (0).

WordWrapMode

Gets/sets the current word wrap and word-break options for the rich edit control.

(GET) PROPERTY WordWrapMode () AS DWORD
(SET) PROPERTY WordWrapMode (BYVAL values AS DWORD) AS DWORD

FUNCTION GetWordWrapMode () AS DWORD
FUNCTION SetWordWrapMode (BYVAL values AS LONG) AS LONG

Return value

(GET) The the current word wrap and word-break options.

(SET) This method returns the current word-wrapping and word-breaking options.

Remarks

This property is supported only in Asian-language versions of Microsoft Rich Edit 1.0. It is not supported in any later versions of Rich Edit. This message must not be sent by the application-defined, word-break procedure.

CallAutocorrectProc

Calls the autocorrect callback function that is stored by the (SET) AutocorrectProc property, provided that the text preceding the insertion point is a candidate for autocorrection.

FUNCTION CallAutocorrectProc (BYVAL char AS WCHAR) AS LONG

Return value

The return value is zero if the message succeeds, or nonzero if an error occurs.

CanPaste

Determines whether a rich edit control can paste a specified clipboard format.

FUNCTION CanPaste (BYVAL clipformat AS LONG) AS BOOLEAN

Return value

If the clipboard format can be pasted, the return value is a nonzero value. If the clipboard format cannot be pasted, the return value is zero.

CanRedo

Determines whether there are any actions in the control redo queue.

FUNCTION CanRedo () AS BOOLEAN

Return value

If there are actions in the control redo queue, the return value is a nonzero value. If the redo queue is empty, the return value is zero.

CanUndo

Determines whether there are any actions in an edit control’s undo queue.

FUNCTION CanUndo () AS BOOLEAN

Return value

If there are actions in the control’s undo queue, the return value is nonzero. If the undo queue is empty, the return value is zero.

DisplayBand

Displays a portion of the contents of a rich edit control, as previously formatted for a device using the FormatRange method.

FUNCTION DisplayBand (BYREF rc AS .RECT) AS BOOLEAN

Return value

If the operation succeeds, the return value is TRUE. If the operation fails, the return value is FALSE.

Remarks

Text and Component Object Model (COM) objects are clipped by the rectangle. The application does not need to set the clipping region.

Banding is the process by which a single page of output is generated using one or more separate rectangles, or bands. When all bands are placed on the page, a complete image results. This approach is often used by raster printers that do not have sufficient memory or ability to image a full page at one time. Banding devices include most dot matrix printers as well as some laser printers.

EmptyUndoBuffer

Resets the undo flag of a rich edit control. The undo flag is set whenever an operation within the rich edit control can be undone.

SUB EmptyUndoBuffer ()

Return value

This method does not return a value.

Remarks

The undo flag is automatically reset whenever the edit control receives a WM_SETTEXT or EM_SETHANDLE message.

ExGetSel

Oveloaded method to retrieve the starting and ending character positions of the selection in a rich edit control.

FUNCTION ExGetSel OVERLOAD () AS CHARRANGE
FUNCTION ExGetSel OVERLOAD (BYREF cpMin AS LONG, BYVAL cpMax AS LONG)

Return value

The first overloaded method returns a CHARRANGE structure with the selection range.

The second overloaded method does not return a value. The values are filled in the passed parameters.

CHARRANGE structure

type _charrange field = 4
   cpMin as LONG
   cpMax as LONG
end type

type CHARRANGE as _charrange

ExLimitText

Sets an upper limit to the amount of text the user can type or paste into a rich edit control.

SUB ExLimitText (BYVAL dwLimit AS DWORD)

Remarks

The text limit set by the ExLimitText method does not limit the amount of text that you can stream into a rich edit control using the StreamIn method with the pedst parameter set to SF_TEXT. However, it does limit the amount of text that you can stream into a rich edit control using the StreamIn method with the pedst parameter set set to SF_RTF.

Before ExLimitText is called, the default limit to the amount of text a user can enter is 32,767 characters.

Return value

This method does not return a value.

ExLineFromChar

Determines which line contains the specified character in a rich edit control.

FUNCTION ExLineFromChar (BYVAL iIndex AS LONG) AS LONG

Return value

Returns the zero-based index of the line.

ExSetSel

Overloaded method that selects a range of characters and/or Component Object Model (COM) objects in a Microsoft Rich Edit control.

FUNCTION ExSetSel OVERLOAD (BYREF cr AS CHARRANGE) AS DWORD
SUB ExSetSel OVERLOAD (BYVAL cpMin AS LONG = 0, BYVAL cpMax AS LONG = -1)

CHARRANGE structure

type _charrange field = 4
   pMin as LONG
   cpMax as LONG
end type

type CHARRANGE as _charrange

Return value

The return value is the selection that is actually set.

Usage example

DIM chrRange AS CHARRANGE = TYPE<CHARRANGE>(3, 12)
pRichEditCtro.ExSetSel(@chrRange)

FindText

Overloaded method to find text within a rich edit control.

FUNCTION FindText OVERLOAD (BYVAL fOptions AS DWORD, BYREF ft AS FINDTEXTW) AS LONG
FUNCTION FindText OVERLOAD (BYVAL fOptions AS DWORD = FR_DOWN, BYVAL cpMin AS LONG = 0, _
   BYVAL cpMax AS LONG = -1, BYREF wszText AS WSTRING) AS LONG

Return value

If the target string is found, the return value is the zero-based position of the first character of the match. If the target is not found, the return value is -1.

Search in a range:

DIM dws AS DWSTRING = "box"
DIM cbStart AS LONG = pRichEdit.FindText(FR_DOWN, 5, 20, cws)
pRichEdit.ExSetSel(cbStart, cbStart + LEN(dws))

Search in the entire document:

DIM dws AS DWSTRING = "box"
DIM cbStart AS LONG = pRichEdit.FindText(FR_DOWN, 0, -1, dws)
--or--
DIM cbStart AS LONG = pRichEdit.FindText(FR_DOWN, , , dws)
pRichEdit.ExSetSel(cbStart, cbStart + LEN(cws))

Case sensitive search:

DIM wws AS DWSTRING = "box"
DIM cbStart AS LONG = pRichEdit.FindText(FR_DOWN OR FR_MATCHCASE, 5, 20, cws)
pRichEdit.ExSetSel(cbStart, cbStart + LEN(wws))

Search backwards from the end of the document to the beginning:

DIM cbStart AS LONG = pRichEdit.GetTextLength
DIM cbStart AS LONG = pRichEdit.FindText(0, cbStart, 0, cws)
pRichEdit.ExSetSel(cbStart, cbStart + LEN(cws))

FindTextEx

Overloaded method to find text within a rich edit control.

FUNCTION FindTextEx OVERLOAD (BYVAL fOptions AS DWORD, BYREF ftexw AS FINDTEXTEXW) AS LONG
FUNCTION FindTextEx OVERLOAD (BYVAL fOptions AS DWORD = FR_DOWN, BYVAL cpMin AS LONG = 0, _
   BYVAL cpMax AS LONG = -1, BYREF wszText AS WSTRING) AS CHARRANGE

Return value

First overloaded function: If the target string is found, the return value is the zero-based position of the first character of the match. If the target is not found, the return value is -1.

Second overloaded function: A CHARRANGE structure. The range of characters in which the text was found. If the text was not found, cpMin and cpMax are -1.

Remarks

FindTextEx uses the FINDTEXTEXW structure, while FindTex uses the FINDTEXTW structure. The difference is that FindTextEx reports the range of text that was found.

Usage examples

Search in a range:

DIM dws AS DWSTRING =  "box"
DIM chrg AS CHARRANGE = pRichEdit.FindTextEx(FR_DOWN, 5, 20, dws)
pRichEdit.ExSetSel(chrg.cpMin, chrg.cpMax)

Search in the entire document:

DIM dws AS DWSTRING =  "box"
DIM chrg AS CHARRANGE = pRichEdit.FindTextEx(FR_DOWN, 0, -1, dws)
--or--
DIM chrg AS CHARRANGE = pRichEdit.FindTextEx(FR_DOWN, , , dws)
pRichEdit.ExSetSel(chrg.cpMin, chrg.cpMax)

Search backwards from the end of the document to the beginning:

DIM cbStart AS LONG = pRichEdit.GetTextLength
DIM chrg AS CHARRANGE = pRichEdit.FindTextEx(0, cbStart, 0, dws)
pRichEdit.ExSetSel(chrg.cpMin, chrg.cpMax)

FindWordBreak

Finds the next word break before or after the specified character position or retrieves information about the character at that position.

FUNCTION FindWordBreak (BYVAL fOperation AS DWORD, BYVAL dwStartPos AS DWORD) AS DWORD

Return value

The method returns a value based on the fOperation parameter.

Remarks

If fOperation is WB_LEFT and WB_RIGHT, the word-break procedure finds word breaks only after delimiters. This matches the functionality of an edit control. If fOperation is WB_MOVEWORDLEFT or WB_MOVEWORDRIGHT, the word-break procedure also compares character classes and word-break flags.

For information about character classes and word-break flags, see Word and Line Breaks.

FormatRange

Formats a range of text in a rich edit control for a specific device.

FUNCTION FormatRange (BYVAL fRender AS LONG, BYREF fr AS FORMATRANGE) AS DWORD

Return value

This method returns the index of the last character that fits in the region, plus 1.

Remarks

This method is typically used to format the content of rich edit control for an output device such as a printer.

After using this method to format a range of text, it is important that you free cached information by sending FormatRange again, but with fr set to NULL; otherwise, a memory leak will occur. Also, after using this message for one device, you must free cached information before using it again for a different device.

GetCharFromPos

Gets information about the character closest to a specified point in the client area of an edit control.

FUNCTION GetCharFromPos (BYREF ptl AS .POINTL) AS LONG

Return value

The return value specifies the zero-based character index of the character nearest the specified point. The return value indicates the last character in the edit control if the specified point is beyond the last character in the control.

GetIMEColor

Gets the Input Method Editor (IME) composition color. This message is available only in Asian-language versions of the operating system.

FUNCTION GetIMEColor (BYVAL rgCmpclr AS .COMPCOLOR PTR) AS LONG
   RETURN this.SetResult(SendMessageW(m_hRichEdit, EM_GETIMECOLOR, 0, cast(LPARAM, rgCmpclr)))
END FUNCTION

Return value

If the operation succeeds, the return value is a nonzero value. If the operation fails, the return value is zero. Call GetErrorInfo to get information about the result.

Note

This message is supported only in Asian-language versions of Microsoft Rich Edit 1.0. It is not supported in any later versions.

GetIMECompMode

Gets the current IME mode for a rich edit control.

FUNCTION GetIMECompMode () AS DWORD

Return value

The return value is one of the following values.

GetIMECompText

Gets the Input Method Editor (IME) composition text.

FUNCTION GetIMECompText (BYREF ict AS .IMECOMPTEXT, BYVAL buffer AS ANY PTR) AS DWORD

Return value

If successful, the return value is the number of Unicode characters copied to the buffer. Otherwise, it is zero.

Remarks

This message only takes Unicode strings.

Security Warning: Be sure to have a buffer sufficient for the size of the input. Failure to do so could cause problems for your application.

GetIMEProperty

Gets the property and capabilities of the Input Method Editor (IME) associated with the current input locale.

FUNCTION GetIMEProperty (BYVAL figp AS DWORD) AS DWORD

Return value

Returns the property or capability value, depending on the value of the figp parameter.

Remarks

If figp is IGP_PROPERTY, it returns one or more of the following values.

If figp is IGP_UI, it returns one or more of the following values.

If figp is IGP_SETCOMPSTR, it returns one or more of the following values.

If figp is IGP_SELECT, it returns one or more of the following values.

If figp is IGP_GETIMEVERSION, it returns one or more of the following values.

This message is similar to ImmGetProperty, except that it uses the current input locale. The application should call IsIME method before calling this function.

GetLine

Copies a line of text from a rich edit control.

FUNCTION GetLine (BYVAL which AS DWORD) AS DWSTRING

Return value

A copy of the line.

GetLineCount

Gets the number of lines in a multiline rich edit control.

FUNCTION GetLineCount () AS LONG

Return value

The return value is an integer specifying the total number of text lines in the multiline edit control or rich edit control. If the control has no text, the return value is 1. The return value will never be less than 1.

Remarks

The GetLineCount method retrieves the total number of text lines, not just the number of lines that are currently visible.

If the Wordwrap feature is enabled, the number of lines can change when the dimensions of the editing window change.

GetOleInterface

Retrieves an IRichEditOle object that a client can use to access a rich edit control’s Component Object Model (COM) functionality.

FUNCTION GetOleInterface () AS IRichEditOle PTR

Return value

A pointer to the IRichEditOle interface. The control calls the AddRef method for the object before returning, so the calling application must call the Release method when it is done with the object. |

GetSel

Gets the starting and ending character positions of the current selection in a rich edit control.

FUNCTION GetSel OVERLOAD (BYREF dwStartPos AS DWORD, BYREF dwEndPos AS DWORD) AS LONG
FUNCTION GetSel OVERLOAD () AS .POINTL

Return value

The return value is a zero-based value with the starting position of the selection in the LOWORD and the position of the first character after the last selected character in the HIWORD. If either of these values exceeds 65,535, the return value is -1. It is better to use the values returned in dwStartPos and dwEndPos because they are full 32-bit values.

The second overloaded method returns a POINTL structure. The x and y members of this structure receive the starting and ending positions of the selection.

Remarks

If there is no selection, the starting and ending values are both the position of the caret.

You can also use the ExtGetSel method to retrieve the same information. ExtGetSel also returns starting and ending character positions as 32-bit values. A combination of the use of ExtGetSel and GetSelText are used in the GetSelText method to retrieve the selected text as a DWSTRING.

GetSelText

Retrieves the currently selected text in a rich edit control.

FUNCTION GetSelText () AS DWSTRING

Return value

The selected text as a DWSTRING (dynamic unicode string).

GetTableParams

Retrieves the table parameters for a table row and the cell parameters for the specified number of cells.

FUNCTION GetTableParams (BYREF tp AS TABLEROWPARMS, BYREF tcp AS TABLECELLPARMS) AS DWORD

Return value

Returns S_OK if successful, or one of the following error codes.

Remarks

This method gets the table parameters for the row at the character position specified by the cpStartRow member of the TABLEROWPARMS structure, and the number of cells specified by the cCells member of the TABLECELLPARMS structure.

The character position specified by the cpStartRow member of the TABLEROWPARMS structure should be at the start of the table row, or at the end delimiter of the table row. If cpStartRow is set to 1, the character position is given by the current selection. In this case, position the selection at the end of the row (between the cell mark and the end delimiter of the table row), or select the row.

GetRawText

Gets the raw text exactly as it appears in memory.

FUNCTION GetRawText () AS STRING

Return value

The retrieved text.

Remarks

Text is retrieved exactly as it appears in memory. This includes special structure characters for table row and cell delimiters as well as math object delimiters (start delimiter U+FDD0, argument delimiter U+FDEE, and end delimiter U+FDDF) and object markers (U+FFFC). This maintains character-position alignment between the retrieved text and the text in memory.

GetRawTextLength

Gets the length of the raw text.

FUNCTION GetRawTextLength () AS LONG

Return value

The retrieved length.

SaveRawText

Saves the raw contents of the rich edit control to a file.

FUNCTION SaveRawText (BYREF wszFilename AS WSTRING, BYVAL Overwrite AS BOOLEAN = FALSE, _
   BYVAL dwFlagsAndAttributes AS DWORD = FILE_ATTRIBUTE_NORMAL) AS BOOLEAN

Return value

A bollean true (-1) of false (0).

Usage example

RichEdit->SaveRawText(AfxGetExePath & "\test.txt", TRUE)

GetTextEx

Gets all of the text from the rich edit control in any particular code base you want.

FUNCTION GetTextEx (BYREF gtex AS GETTEXTEX, BYVAL buffer AS ANY PTR) AS DWORD

Return value

The return value is the number of characters copied into the output buffer, not including the null terminator.

Remarks

If the size of the output buffer is less than the size of the text in the control, the edit control will copy text from its beginning and place it in the buffer until the buffer is full. A terminating null character will still be placed at the end of the buffer.

GetTextRange

Overloaded method that retrieves a specified range of characters from a rich edit control.

FUNCTION GetTextRange (BYREF trg AS .TEXTRANGEW) AS DWORD
FUNCTION GetTextRange (BYVAL cpMin AS LONG = 0, BYVAL cpMax AS LONG = -1) AS DWSTRING

Return value

The first overloaded method returns the number of characters copied, not including the terminating null character.

The second overloaded method returns the retrieved text.

Usage examples

Retrieve all the text using the first overloaded method:

DIM cbLen AS LONG = pRichEdit.GetTextLEngth
DIM wstrText AS DWSTRING = WSPACE(cbLen + 1)
DIM trg AS TEXTRANGEW
trg.chrg.cpMin = 0
trg.chrg.cpMax = -1
trg.lpstrText = wstrtext
pRichEdit.GetTextRange(trg)
AfxMsg wstrtext

Retrieve all the text using the second overloaded method:

DIM dws AS DWSTRING = pRichEdit.GetTextRange
AfxMsg dws

Retrieve a range of text.

DIM sws AS DWSTRING = pRichEdit.GetTextRange(5, 15)
AfxMsg sws

GetThumb

Gets the position of the scroll box (thumb) in the vertical scroll bar of a multiline rich edit control.

FUNCTION GetThumb () AS LONG

Return value

The return value is the position of the scroll box.

UndoName

Retrieves the type of the next undo action, if any.

FUNCTION UndoName () AS DWORD
FUNCTION GetUndoName () AS DWORD

Return value

If there is an undo action, the value returned is an UNDONAMEID enumeration value that indicates the type of the next action in the control’s undo queue.

If there are no actions that can be undone or the type of the next undo action is unknown, the return value is zero.

UNDONAMEID enumeration

4 | Name | Value | Description | | —————– | —– | ———– | | UID_UNKNOWN | 0 | The type of undo action is unknown. | | UID_TYPING | 1 | Typing operation. | | UID_DELETE | 2 | Delete operation. | | UID_DRAGDROP | 3 | Drag-and-drop operation. | | UID_CUT | 4 | Cut operation. | | UID_PASTE | 5 | Paste operation. | | UID_AUTOTABLE | 6 | Automatic table insertion; for example, typing +—+—+ to insert a table row. |

Remarks

The types of actions that can be undone or redone include typing, delete, drag, drop, cut, and paste operations. This information can be useful for applications that provide an extended user interface for undo and redo operations, such as a drop-down list box of actions that can be undone.

GetZoom

Gets the current zoom ratio, which is always between 1/64 and 64.

FUNCTION GetZoom (BYREF pzNum AS DWORD, BYREF pzDen AS DWORD) AS LONG

Return value

The message returns TRUE if message is processed, which it will be if both pzNum and pzDen are not NULL.

HideSelection

Hides or shows the selection in a rich edit control.

SUB HideSelection (BYVAL fHide AS DWORD)

Return value

This message does not return a value.

InsertImage

Overloaded method that replaces the selection with a blob that displays an image. It uses pixels instead of HIMETRIC units and it is DPI aware. Can insert and display .bmp, .jpg, .png and .gif files.

FUNCTION InsertImage OVERLOAD (BYREF wszFileName AS WSTRING, BYVAL xWidth AS LONG = 0, BYVAL yHeight AS LONG = 0, _
BYVAL Ascent AS LONG = 0, BYVAL nType AS LONG = TA_BASELINE, BYREF wszAlternateText AS WSTRING = "") AS BOOLEAN

Return value

Returns a boolean value: 0 for success and -1 for failure. To get extended error information call GetErrorInfo, which can return S_OK if successful, or one of the following error codes.

Overloaded method that replaces the selection with a blob that displays an image. Uses HIMETRIC units.

FUNCTION InsertImage OVERLOAD (BYREF ip AS RICHEDIT_IMAGE_PARAMETERS) AS DWORD

Return value

Returns S_OK if successful, or one of the following error codes.

InsertObject

Inserts an image or a Ole object in the rich edit control. See MSDN: https://learn.microsoft.com/en-us/windows/win32/controls/using-rich-edit-com Remarks: To insert images, use the InsertImage method, because the InsertObject method won’t display the image, but an icon, when the image type is not a bitmap.

FUNCTION InsertObject (BYREF wszFileName AS WSTRING) AS BOOLEAN

Return value

Returns a boolean true (-1) for success of false (0) for failure. To get extended information call the GetErrorInfo method.

InsertTable

Inserts one or more identical table rows with empty cells.

FUNCTION InsertTable (BYREF tp AS TABLEROWPARMS, BYREF tcp AS TABLECELLPARMS) AS DWORD

Return value

Returns S_OK if the table is inserted, or an error code if not.

Remarks

If the cpStartRow member of the TABLEROWPARMS is –1, this message deletes the selected text (if any), and then inserts empty table rows with the row and cell parameters given by lptp^ and lptcp. It leaves the selection pointing to the start of the first cell in the first row. The client can then populate the table cells by pointing the selection (or an ITextRange) to the various cell end marks and inserting and formatting the desired text. Such text can include nested table rows. Alternatively, if the cpStartRow member of the TABLEROWPARMS is 0 or greater, table rows are inserted at the character position given by cpStartRow. This only changes the current selection if the table is inserted inside the selected text.

A Microsoft Rich Edit table consists of a sequence of table rows which, in turn, consist of sequences of paragraphs. A table row starts with the special two-character delimiter paragraph U+FFF9 U+000D and ends with the two-character delimiter paragraph U+FFFB U+000D. Each cell is terminated by the cell mark U+0007, which is treated as a hard end-of-paragraph mark just as U+000D (CR) is. The table row and cell parameters are treated as special paragraph formatting of the table-row delimiters. The formatting contains the information in the TABLEROWPARMS structure. The cell parameters given by the TABLECELLPARMS structure are stored in an expanded version of the tabs array. This format allows tables to be nested within other tables, up to fifteen levels deep.

IsIME

Determines if current input locale is an East Asian locale.

FUNCTION IsIME () AS LONG

Return value

Returns TRUE if it is an East Asian locale. Otherwise, it returns FALSE.

LineFromChar

Gets the index of the line that contains the specified character index in a multiline rich edit control.

FUNCTION LineFromChar (BYVAL index AS DWORD) AS LONG

Return value

The return value is the zero-based line number of the line containing the character index specified by index.

LineIndex

Gets the character index of the first character of a specified line in a multiline rich edit control.

FUNCTION LineIndex (BYVAL nLine AS LONG) AS LONG

Return value

The return value is the character index of the line specified in the nLine parameter, or it is -1 if the specified line number is greater than the number of lines in the edit control.

LineLength

Retrieves the length, in characters, of a line in a rich edit control.

FUNCTION LineLength (BYVAL index AS DWORD) AS LONG

Return value

If index is greater than the number of characters in the control, the return value is zero.

LineScroll

Scrolls the text in a multiline rich edit control.

FUNCTION LineScroll (BYVAL y AS LONG) AS LONG

Return value

TRUE or FALSE.

Remarks

The control does not scroll vertically past the last line of text in the edit control. If the current line plus the number of lines specified by the y parameter exceeds the total number of lines in the edit control, the value is adjusted so that the last line of the edit control is scrolled to the top of the edit-control window.

Margins

Sets the widths of the left and right margins for a rich edit control. The message redraws the control to reflect the new margins.

FUNCTION Margins (BYVAL nMargins AS LONG, BYVAL nWidth AS LONG)
SUB SetMargins (BYVAL nMargins AS LONG, BYVAL nWidth AS LONG)
PROPERTY LeftMargin (BYVAL nWidth AS LONG)
PROPERTY RightMargin (BYVAL nWidth AS LONG)
SUB SetLeftMargin (BYVAL nWidth AS LONG)
SUB SetRightMargin (BYVAL nWidth AS LONG)

Usage examples

Set the left margin

pRichEdit.SetMargins(EC_LEFTMARGIN, MAKELONG(50, 0))
--or--
pRichEdit.SetMargins(EC_LEFTMARGIN, MAKELONG(50))
--or--
pRichEdit.Margins(EC_LEFTMARGIN) = MAKELONG(50, 0)
--or--
pRichEdit.LeftMargin = 50

Set the right margin

pRichEdit.SetMargins(EC_RIGHTMARGIN, MAKELONG(0, 50))
--or--
pRichEdit.Margins(EC_RIGHTMARGIN) = MAKELONG(0, 50)
--or--
pRichEdit.RightMargin = 50

Set both margins

pRichEdit.SetMargins(EC_LEFTMARGIN OR EC_RIGHTMARGIN, MAKELONG(50, 50))
--or--
pRichEdit.Margins(EC_LEFTMARGIN OR EC_RIGHTMARGIN) = MAKELONG(50, 50)

PasteSpecial

Pastes a specific clipboard format in a rich edit control.

SUB PasteSpecial OVERLOAD (BYVAL clpfmt AS DWORD, BYREF rps AS REPASTESPECIAL)
SUB PasteSpecial OVERLOAD (BYVAL clpfmt AS DWORD, BYVAL dwAspect AS DWORD, BYVAL hMF AS HMETAFILE)

PosFromChar

Retrieves the client area coordinates of a specified character in a rich edit control.

FUNCTION PosFromChar (BYVAL index as DWORD) AS .POINTL

Return value

A POINTL structure with receives the client area coordinates of the character. The coordinates are in screen units and are relative to the upper-left corner of the control’s client area.

Remarks

A returned coordinate can be a negative value if the specified character is not displayed in the edit control’s client area. The coordinates are truncated to integer values.

If the character is a line delimiter, the returned coordinates indicate a point just beyond the last visible character in the line. If the specified index is greater than the index of the last character in the control, the control returns -1.

Reconversion

Invokes the Input Method Editor (IME) reconversion dialog box.

SUB Reconversion ()

Return value

Thismethod does not return a value.

Redo

Redoes the next action in the control’s redo queue.

FUNCTION Redo () AS LONG

Return value

If the Redo operation succeeds, the return value is a nonzero value. If the Redo operation fails, the return value is zero.

Remarks

To determine whether there are any actions in the control’s redo queue, call the CanRedo method.

ReplaceSel

Replaces the current selection in a rich edit control with the specified text.

SUB ReplaceSel (BYVAL bCanBeUndone AS LONG = TRUE, BYREF wszText AS WSTRING)

Remarks

Use the ReplaceSel method to replace only a portion of the text in an edit control. To replace all of the text, use the Text property.

If there is no selection, the replacement text is inserted at the caret.

In a rich edit control, the replacement text takes the formatting of the character at the caret or, if there is a selection, of the first character in the selection.

RequestResize

Forces a rich edit control to send an EN_REQUESTRESIZE notification message to its parent window.

SUB RequestResize ()

Remarks

This message is useful during WM_SIZE processing for the parent of a bottomless rich edit control.

Scroll

Scrolls the text vertically in a multiline rich edit control.

FUNCTION Scroll (BYVAL nAction AS LONG) AS LONG

Return value

If the method is successful, the HIWORD of the return value is TRUE, and the LOWORD is the number of lines that the command scrolls. The number returned may not be the same as the actual number of lines scrolled if the scrolling moves to the beginning or the end of the text. If the nAction parameter specifies an invalid value, the return value is FALSE.

Remarks

To scroll to a specific line or character position, use the LineScroll method. To scroll the caret into view, use the ScrollCaret method.

ScrollCaret

Scrolls the caret into view in a rich edit control.

SUB ScrollCaret ()

Return value

The return value is not meaningful.

SelectionType

Determines the selection type for a rich edit control.

FUNCTION SelectionType () AS LONG

Return value

If the selection is not empty, the return value is a set of flags containing one or more of the following values.

Remarks

This message is useful during WM_SIZE processing for the parent of a bottomless rich edit control.

SetBkgndColor

Sets the background color for a rich edit control.

FUNCTION SetBkgndColor (BYVAL SysColor AS DWORD, BYVAL BkColor AS DWORD) AS DWORD

Return value

This message returns the original background color.

SetFontSize

Sets the font size for the selected text.

FUNCTION SetFontSize (BYVAL ptsize AS LONG) AS LONG

Return value

If no error occurred, the return value is TRUE. If an error occurred, the return value is FALSE.

Remarks

You can easily get the font size by calling the CharFormat property.

Rich Edit first adds ptsize to the current font size and then uses the resulting size and the following table to determine the rounding value.

If the resulting font size is not evenly divisible by the rounding value, the font size is then rounded to a number evenly divisible by the rounding value. So if the font size is less than or equal to 12, the rounding value will be 1. Similarly, if the font size is less than or equal to 28, the rounding value is 2. For values greater than 28, font sizes are rounded to the next band. So, the font size jumps to 36, 48, 72, 80. After 80, all rounding is done in increments of ten points.

The font size is rounded up or down depending on the sign of ptsize. If ptsize is positive, the rounding is always up. Otherwise, rounding is always down. So, if the current font size is 10 and ptsize is 3, the resulting font size would be 14 (10 + 3 = 13, which is not divisible by 2, so the size rounds up to 14). Conversely, if the current font size is 14 and ptsize is -3, the resulting font size would be 10 (14 - 3 = 11, which is not divisible by 2, so the size rounds down to 10).

The change is applied to each part of the selection. So, if some of the text is 10pt and some 20pt, after a call with ptsize set to 1, the font sizes become 11pt and 22pt, respectively.

Additional examples are shown in the following table.

SetIMEColor

Sets the Input Method Editor (IME) composition color. This message is available only in Asian-language versions of the operating system.

FUNCTION SetIMEColor (BYVAL pcompcolor AS .COMPCOLOR PTR) AS LONG
   RETURN this.SetResult(SendMessageW(m_hRichEdit, EM_SETIMECOLOR, 0, cast(LPARAM, pcompcolor)))
END FUNCTION

Return value

If the operation succeeds, the return value is a nonzero value. If the operation fails, the return value is zero. Call GetErrorInfo to get information about the result.

Note

This message is supported only in Asian-language versions of Microsoft Rich Edit 1.0. It is not supported in any later versions.

SetOleCallback

Gives a rich edit control an IRichEditOleCallback object that the control uses to get OLE-related resources and information from the client.

FUNCTION SetOleCallback (BYVAL pCallback AS ANY PTR) AS LONG

Return value

If the operation succeeds, the return value is a nonzero value. If the operation fails, the return value is zero.

SetPalette

Changes the palette that a rich edit control uses for its display window.

SUB SetPalette (BYVAL newPalette AS HPALETTE)

Return value

This method does notreturn a value.

Remarks

The rich edit control does not check whether the new palette is valid.

SetReadOnly

Sets or removes the read-only style (ES_READONLY) of a rich edit control.

FUNCTION SetReadOnly (BYVAL fReadOnly AS LONG) AS BOOLEAN

Return value

Returns the boolean true (-1) or false (0).

Remarks

When an edit control has the ES_READONLY style, the user cannot change the text within the edit control.

To determine whether an edit control has the ES_READONLY style, use the Windows API GetWindowLong function with the GWL_STYLE flag.

SetSel

Selects a range of characters in a rich edit control.

SUB SetSel OVERLOAD (BYVAL nStart AS LONG, BYVAL nEnd AS LONG)
SUB SetSel OVERLOAD (BYREF pt AS POINTL)

Remarks

The start value can be greater than the end value. The lower of the two values specifies the character position of the first character in the selection. The higher value specifies the position of the first character beyond the selection.

The start value is the anchor point of the selection, and the end value is the active end. If the user uses the SHIFT key to adjust the size of the selection, the active end can move but the anchor point remains the same.

If the start is 0 and the end is -1, all the text in the edit control is selected. If the start is -1, any current selection is deselected.

If the edit control has the ES_NOHIDESEL style, the selected text is highlighted regardless of whether the control has focus. Without the ES_NOHIDESEL style, the selected text is highlighted only when the edit control has the focus.

SetTableParams

Changes the parameters of rows in a table.

FUNCTION SetTableParams (BYREF tp AS TABLEROWPARMS, BYREF tcp AS TABLECELLPARMS) AS DWORD

Return value

Returns S_OK if successful, or one of the following error codes.

Remarks

This message changes the parameters of the number of rows specified by the cRow member of the TABLEROWPARMS structure, if the table has that many consecutive rows. If cRow is less than 0, the message iterates until the end of the table. If the new cell count differs from the current cell count by +1 or 1, it inserts or deletes the cell at the index specified by the iCell member of TABLEROWPARMS. The starting table row is identified by a character position. This position is specified by cpStartRow members with values that are greater than or equal to zero. The position should be inside the table row, but not inside a nested table, unless you want to change that table s parameters. If the cpStartRow member is 1, the character position is given by the current selection. For this, position the selection anywhere inside the table row, or select the row with the active end of the selection at the end of the table row.

SetTabStops

Sets the tab stops in a multiline rich edit control.

FUNCTION SetTabStops (BYVAL nTabs AS LONG, BYVAL rgTabStops AS LONG_PTR) AS LONG

Return value

If all the tabs are set, the return value is TRUE.

If all the tabs are not set, the return value is FALSE.

Remarks

The EM_SETTABSTOPS message does not automatically redraw the edit control window. If the application is changing the tab stops for text already in the edit control, it should call the Windows API InvalidateRect function to redraw the edit control window.

The values specified in the array are in dialog template units, which are the device-independent units used in dialog box templates. To convert measurements from dialog template units to screen units (pixels), use the Windows API MapDialogRect function.

Rich Edit: Supported in Microsoft Rich Edit 3.0 and later. A rich edit control can have the maximum number of tab stops specified by MAX_TAB_STOPS.

SetTargetDevice

Sets the target device and line width used for WYSIWYG formatting in a rich edit control.

FUNCTION SetTargetDevice (BYVAL hDC AS HDC, BYVAL lnwidth AS LONG) AS BOOLEAN

Return value

If the method succeeds it returns the boolean value true (-1); if it fails, it returns false (0).

Remarks

The HDC for the default printer can be obtained as follows.

DIM hdc AS HDC
DIM pd AS PRINTDLGW
pd.lStructSize = SIZEOF(pd)
pd.flags = PD_RETURNDC OR PD_RETURNDEFAULT
IF PrintDlgW(@pd) THEN
   hdc =  = pd.hDC
END IF

If lnwidth is zero, no line breaks are created.

SetTextEx / InsertText / ReplaceText

Combines the functionality of WM_SETTEXT and EM_REPLACESEL and adds the ability to set text using a code page and to use either Rich Text Format (RTF) rich text or plain text.

FUNCTION SetTextEx OVERLOAD (BYREF stex AS SETTEXTEX, BYVAL buffer AS ANY PTR) AS DWORD
FUNCTION SetTextEx OVERLOAD (BYREF stex AS .SETTEXTEX, BYREF strText AS STRING) AS DWORD
FUNCTION SetTextEx OVERLOAD (BYREF stex AS .SETTEXTEX, BYREF wszText AS WSTRING) AS DWORD
FUNCTION SetTextEx OVERLOAD (BYREF strText AS STRING) AS DWORD
FUNCTION SetTextEx OVERLOAD (BYREF wszText AS WSTRING) AS DWORD
FUNCTION SetTextEx OVERLOAD (BYVAL nStart AS LONG, BYVAL nEnd AS LONG, BYREF strText AS STRING) AS DWORD
FUNCTION SetTextEx OVERLOAD (BYVAL nStart AS LONG, BYVAL nEnd AS LONG, BYREF wszText AS WSTRING) AS DWORD
FUNCTION SetTextEx OVERLOAD (BYVAL nPos AS LONG, BYREF strText AS STRING) AS DWORD
FUNCTION SetTextEx OVERLOAD (BYVAL nPos AS LONG, BYREF wszText AS WSTRING) AS DWORD
FUNCTION InsertText OVERLOAD (BYREF strText AS STRING) AS DWORD
FUNCTION InsertText OVERLOAD (BYREF wszText AS WSTRING) AS DWORD
FUNCTION InsertText OVERLOAD (BYVAL nPos AS LONG, BYREF strText AS STRING) AS DWORD
FUNCTION InsertText OVERLOAD (BYVAL nPos AS LONG, BYREF wszText AS WSTRING) AS DWORD
FUNCTION ReplaceText OVERLOAD (BYVAL nStart AS LONG, BYVAL nEnd AS LONG, BYREF strText AS STRING) AS DWORD
FUNCTION ReplaceText OVERLOAD (BYVAL nStart AS LONG, BYVAL nEnd AS LONG, BYREF wszText AS WSTRING) AS DWORD

SETTEXTEX flags

Option flags. It can be any reasonable combination of the following flags.

SETTEXTEX codepage

The code page used to translate the text to Unicode. If codepage is 1200 (Unicode code page), no translation is done. If codepage is CP_ACP, the system code page is used.

Return value

If the operation is setting all of the text and succeeds, the return value is 1.

If the operation is setting the selection and succeeds, the return value is the number of bytes or characters copied.

If the operation fails, the return value is zero.

Usage examples

Inserts ansi text at the caret position:

DIM stex AS .SETTEXTEX
stex.flags = ST_SELECTION OR ST_KEEPUNDO
stex.codepage = CP_ACP
DIM st AS STRING = "New text"
pRichEdit->SetTextEx(stex, st)
--or--
pRichEdit->SetTextEx(st)
--or--
pRichEdit->InsertTextEx(st)

Inserts formatted rich text at the caret position:

DIM stex AS .SETTEXTEX
stex.flags = ST_SELECTION OR ST_KEEPUNDO
stex.codepage = CP_ACP
DIM st AS STRING = $"{\rtf1\ansi New text}"
pRichEdit->SetTextEx(stex, st)
--or--
pRichEdit->SetTextEx(st)
--or--
pRichEdit->InsertTextEx(st)

Inserts unicode text at the caret position:

DIM stex AS .SETTEXTEX
stex.flags = ST_SELECTION OR ST_KEEPUNDO
stex.codepage = 1200
DIM wsz AS WSTRING * 10 = "New text"
pRichEdit->SetTextEx(stex, wsz)
--or--
pRichEdit->SetTextEx(wsz)
--or--
pRichEdit->InsertTextEx(wsz)

DIM stex AS .SETTEXTEX
stex.flags = ST_SELECTION OR ST_KEEPUNDO
stex.codepage = 1200
DIM sws AS DWSTRING = "New text"
pRichEdit->SetTextEx(stex, dws)
--or--
pRichEdit->SetTextEx(dws)
--or--
pRichEdit->InsertTextEx(dws)

Replaces text

pRichEdit->SetTextEx (10, 20, "New Text")

DIM st AS STRING = "New text"
pRichEdit->SetTextEx (10, 20, st)

DIM st AS STRING = $"{\rtf1\ansi New text}"
pRichEdit->SetTextEx (10, 20, st)

DIM wsz AS WSTRING * 10 = "New text"
pRichEdit->SetTextEx (10, 20, wsz)

DIM dws AS DWSTRING = "New text"
pRichEdit->SetTextEx (10, 20, dws)

Inserts text at the specified position:

pRichEdit->SetTextEx (10, "New Text")

DIM st AS STRING = "New text"
pRichEdit->SetTextEx (10, st)

DIM st AS STRING = $"{\rtf1\ansi New text}"
pRichEdit->SetTextEx (10, st)

DIM wsz AS WSTRING * 10 = "New text"
pRichEdit->SetTextEx (10, wsz)

DIM dws AS DWSTRING = "New text"
pRichEdit->SetTextEx (10, dws)

Delete text:

pRichEdit->SetTextEx (10, 20, "")

SetUIAName

Sets the name of a rich edit control for UI Automation (UIA).

FUNCTION SetUIAName (BYREF wszName AS WSTRING) AS DWORD

Return value

TRUE if the name for UIA is successfully set, otherwise FALSE.

SetUndoLimit

Sets the maximum number of actions that can stored in the undo queue.

FUNCTION SetUndoLimit (BYVAL maxactions AS DWORD) AS DWORD

Return value

The return value is the new maximum number of undo actions for the rich edit control. This value may be less than maxactions if memory is limited.

Remarks

By default, the maximum number of actions in the undo queue is 100. If you increase this number, there must be enough available memory to accommodate the new number. For better performance, set the limit to the smallest possible value.

Setting the limit to zero disables the Undo feature.

SetZoom

Sets the zoom ratio for a multiline edit control or a rich edit control. The ratio must be a value between 1/64 and 64. The edit control needs to have the ES_EX_ZOOMABLE extended style set, for this message to have an effect, see Edit Control Extended Styles.

FUNCTION SetZoom (BYVAL zNum AS DWORD, BYVAL zDen AS DWORD) AS LONG

Return value

If the new zoom setting is accepted, the return value is TRUE. If the new zoom setting is not accepted, the return value is FALSE.

ShowScrollBar

Shows or hides one of the scroll bars in the Text Host window.

SUB ShowScrollBar (BYVAL nScrollBar AS DWORD, BYVAL fShow AS LONG)

Remarks

This method is only valid when the control is in-place active. Calls made while the control is inactive may fail.

StopGroupTyping

Stops the control from collecting additional typing actions into the current undo action.

FUNCTION StopGroupTyping () AS DWORD

Return value

The return value is zero. This message cannot fail.

Remarks

A rich edit control groups consecutive typing actions, including characters deleted by using the BackSpace key, into a single undo action until one of the following events occurs:

• The control receives an EM_STOPGROUPTYPING message.
• The control loses focus.
• The user moves the current selection, either by using the arrow keys or by clicking the mouse.
• The user presses the Delete key.
• The user performs any other action, such as a paste operation that does not involve typing.

You can send the RichEdit_StopGroupTyping message to break consecutive typing actions into smaller undo groups. For example, you could send RichEdit_StopGroupTyping after each character or at each word break.

StreamIn

Replaces the contents of a rich edit control with a stream of data provided by an application defined EditStreamCallback callback function.

FUNCTION StreamIn (BYVAL psf AS LONG, BYREF edst AS EDITSTREAM) AS DWORD

Data format and replacement options

In addition, you can specify the following flags.

Return value

This message returns the number of characters read.

Remarks

When you call the StreamIn methos, the rich edit control makes repeated calls to the EditStreamCallback function specified by the pfnCallback member of the EDITSTREAM structure. Each time the callback function is called, it fills a buffer with data to read into the control. This continues until the callback function indicates that the stream-in operation has been completed or an error occurs.

StreamOut

Causes a rich edit control to pass its contents to an application defined EditStreamCallback callback function. The callback function can then write the stream of data to a file or any other location that it chooses.

FUNCTION StreamOut (BYVAL psf AS LONG, BYREF edst AS EDITSTREAM) AS DWORD

Data format and replacement options

The SF_RTFNOOBJS option is useful if an application stores COM objects itself, as RTF representation of COM objects is not very compact. The control word, , followed by a space denotes the object position.

In addition, you can specify the following flags.

Return value

This message returns the number of characters written to the data stream.

Remarks

When you call the StreamOut method, the rich edit control makes repeated calls to the EditStreamCallback function specified by the pfnCallback member of the EDITSTREAM structure. Each time it calls the callback function, the control passes a buffer containing a portion of the contents of the control. This process continues until the control has passed all its contents to the callback function, or until an error occurs.

Undo

First overloaded function: Undoes the last edit control operation in the control’s undo queue.

Second overloaded function: Performs a specified number of undo operations.

SuspendUndo: Suspends undo processing.

ResumeUndo: Resumes undo processing.

FUNCTION Undo () AS LONG
FUNCTION Undo (BYVAL Count AS LONG) AS LONG

DECLARE FUNCTION SuspendUndo () AS LONG
DECLARE FUNCTION ResumeUndo () AS LONG

Return value

First overloaded function: For a single-line edit control, the return value is always TRUE. For a multiline edit control, the return value is TRUE if the undo operation is successful, or FALSE if the undo operation fails.

Second overloaded function: The actual count of undo operations performed. If all of the Count undo operations were performed, it returns S_OK. If the method fails, it returns S_FALSE, indicating that less than Count undo operations were performed.

Remarks

Edit controls and Rich Edit 1.0: An undo operation can also be undone. For example, you can restore deleted text with the first EM_UNDO message, and remove the text again with a second EM_UNDO message as long as there is no intervening edit operation.

Rich Edit 2.0 and later: The undo feature is multilevel so sending two EM_UNDO messages will undo the last two operations in the undo queue. To redo an operation, send the EM_REDO message.

GetLastResult

Returns the last result code

FUNCTION GetLastResult () AS HRESULT
   RETURN m_Result
END FUNCTION

SetResult

Sets the last result code.

FUNCTION SetResult (BYVAL Result AS HRESULT) AS HRESULT
   m_Result = Result
   RETURN m_Result
END FUNCTION

GetErrorInfo

Returns a description of the last result code.

PRIVATE FUNCTION GetErrorInfo (BYVAL nError AS LONG = -1) AS DWSTRING

NewDoc

Opens a new document. If another document is open, this method saves any current changes and closes the current document before opening a new one.

FUNCTION NewDoc () AS HRESULT

Return value

If this method succeeds, it returns S_OK.

Usage example

pRichEdit.NewDoc

OpenDoc

Opens a new document. If another document is open, this method saves any current changes and closes the current document before opening a new one.

FUNCTION OpenDoc (BYVAL pVar AS VARIANT PTR, BYVAL Flags AS LONG = 0, _
   BYVAL CodePage AS LONG = CP_ACP) AS HRESULT

Return value

The return value can be an HRESULT value that corresponds to a system error or COM error code, including one of the following values.

Usage example

DIM dv AS DVARIANT = AfxGetExePath & $"\Test.rtf"
pRichEdit.OpenDoc(dv)

SaveDoc

Saves the document.

FUNCTION SaveDoc (BYVAL pVar AS VARIANT PTR, BYVAL Flags AS LONG = tomRTF, _
   BYVAL CodePage AS LONG = CP_ACP) AS HRESULT

Any combination of these values may be used.

These values are mutually exclusive.

Return value

The return value can be an HRESULT value that corresponds to a system error or COM error code, including one of the following values.

Remarks

To use the parameters that were specified for opening the file, use zero values for the parameters.

If pVar is null or missing, the file name given by this document’s name is used. If both of these are missing or null, the method fails.

If pVar specifies a file name, that name should replace the current Name property. Similarly, the Flags and CodePage arguments can overrule those supplied in the OpenDoc method and define the values to use for files created with the NewDoc method.

Unicode plain-text files should be saved with the Unicode byte-order mark (&hFEFF) as the first character. This character should be removed when the file is read in; that is, it is only used for import/export to identify the plain text as Unicode and to identify the byte order of that text. Microsoft Notepad adopted this convention, which is now recommended by the Unicode standard.

Usage examples

Overwrites the current document in RTF format:

pRichEdit->SaveDoc(BYVAL NULL)
-- or --
pRichEdit->SaveDoc(BYVAL NULL, tomRTF)

Overwrites the current document in text format:

pRichEdit->SaveDoc(BYVAL NULL, tomText)

Overwrites the current document in utf-8 format:

pRichEdit->SaveDoc(BYVAL NULL, tomText, CP_UTF8)

Overwrites the current document in unicode format:

pRichEdit->SaveDoc(BYVAL NULL, tomText, 1200)

Saves the current document in RTF format:

DIM dv AS DVARIANT = AfxGetExePath & $"\Test02.rtf"
pRichEdit->SaveDoc(dv, tomCreateAlways OR tomRTF)

Saves the current document in text format:

DIM dv AS DVARIANT = AfxGetExePath & $"\Test02.txt"
pRichEdit->SaveDoc(dv, tomCreateAlways OR tomText)

Saves the current document in utf-8 (with BOM):

DIM dv AS DVARIANT = AfxGetExePath & $"\Test02.txt"
pRichEdit->SaveDoc(dv, tomCreateAlways OR tomText, CP_UTF8)

Saves the current document in unicode:

DIM dv AS DVARIANT = AfxGetExePath & $"\Test02.txt"
pRichEdit->SaveDoc(dv, tomCreateAlways OR tomText, 1200)

DocName

Gets the path and file name of the document.

PRIVATE FUNCTION DocName () AS DWSTRING
PRIVATE FUNCTION GetDocName () AS DWSTRING

Return value

The path and file name of the document.

GetTextFromFile

Gets text from the specified file

FUNCTION GetTextFromFile (BYREF wszFileName AS WSTRING) AS STRING

Return value

An string with the contents of the file or an empty string if the method fails. Possible errors are E_INVALIDARG (invalid argument) and ERROR_FILE_NOT_FOUND (if the file does not exist). Call the GetErrorInfo method to get error information.

Remarks

This method is used by the AppendDocFile and InsertDocFile methods.

AppendDocFile

Appends the contents of the specified file. Besides .rtf files, this method also insert the content of ansi, unicode or utf8 files if you specify the appropriate code page.

FUNCTION AppendDocFile (BYREF wszFileName AS WSTRING, BYVAL CodePage AS DWORD = CP_ACP) AS DWORD

Usage example

Append a RTF file.

IM wszFileName AS WSTRING * MAX_PATH = AfxGetExePath & $"\Test.rtf"
RichEdit->AppendDocFile(wszFileName)

Append a file with ansi contents.

IM wszFileName AS WSTRING * MAX_PATH = AfxGetExePath & $"\Test.txt"
RichEdit->AppendDocFile(wszFileName, 500, CP_ANSI)
-- or --
RichEdit->AppendDocFile(wszFileName, -1, CP_ANSI)

Append a file with utf8 contents.

IM wszFileName AS WSTRING * MAX_PATH = AfxGetExePath & $"\Test.txt"
RichEdit->AppendDocFile(wszFileName, 500, CP_UTF8)
-- or --
RichEdit->AppendDocFile(wszFileName, -1, CP_UTF8)

Append a file with unicode contents.

IM wszFileName AS WSTRING * MAX_PATH = AfxGetExePath & $"\Test.txt"
RichEdit->AppendDocFile(wszFileName, 500, 1200)
-- or --
RichEdit->AppendDocFile(wszFileName, -1, 1200)

InsertDocFile

Inserts the contents of the specified file at the specified location. Besides .rtf files, this method also insert the content of ansi, unicode or utf8 files if you specify the appropriate code page.

FUNCTION InsertDocFile (BYREF wszFileName AS WSTRING, BYVAL dwPos AS DWORD, BYVAL CodePage AS DWORD = CP_ACP) AS DWORD

Usage examples

Insert a RTF file.

IM wszFileName AS WSTRING * MAX_PATH = AfxGetExePath & $"\Test.rtf"
RichEdit->InsertDocFile(wszFileName, 500)
-- or --
RichEdit->InsertDocFile(wszFileName, -1)

Insert a file with ansi contents.

IM wszFileName AS WSTRING * MAX_PATH = AfxGetExePath & $"\Test.txt"
RichEdit->InsertDocFile(wszFileName, 500, CP_ANSI)
-- or --
RichEdit->InsertDocFile(wszFileName, -1, CP_ANSI)

Insert a file with utf8 contents.

IM wszFileName AS WSTRING * MAX_PATH = AfxGetExePath & $"\Test.txt"
RichEdit->InsertDocFile(wszFileName, 500, CP_UTF8)
-- or --
RichEdit->InsertDocFile(wszFileName, -1, CP_UTF8)

Insert a file with unicode contents.

IM wszFileName AS WSTRING * MAX_PATH = AfxGetExePath & $"\Test.txt"
RichEdit->InsertDocFile(wszFileName, 500, 1200)
-- or --
RichEdit->InsertDocFile(wszFileName, -1, 1200)

GetRtf

Retrieves RTF formatted text from a Rich Edit control.

FUNCTION GetRtf (BYVAL dwOptionsAndFlags AS DWORD = SF_RTF) AS STRING

The SF_RTFNOOBJS option is useful if an application stores COM objects itself, as RTF representation of COM objects is not very compact. The control word, , followed by a space denotes the object position.

In addition, you can specify the following flags.

Return value

Returns the retrieved text or a null string.

LoadRtfFromFile

Loads the contents of a RTF file into a Rich Edit control. Deprecated and removed. Use OpenDoc instead.

FUNCTION LoadRtfFromFile (BYREF wszFileName AS WSTRING) AS BOOLEAN

Return value

If the operation succeeds, the return value is TRUE. If the operation fails, the return value is FALSE.

Remarks

First you have to create an instance of the CRichEditOleCallback class and pass a pointer to it to the rich edit control using the SetOleCallback method.

DIM pRichEditOleCallback AS CRichEditOleCallback = CRichEditOleCallback
pRichEdit.SetOleCallback(@pRichEditOleCallback)

Then load the .rtf file using the LoadRtfFromFile method.

pRichEdit.LoadRtfFromFile(<path and name of the RTF file>)
e.g. pRichEdit->LoadRtfFromFile(AfxGetExePath & "\Test.rtf")

LoadRtfFromResource

Loads a RTF resource file into a Rich Edit control.

FUNCTION LoadRtfFromResource (BYREF wszResourceName AS WSTRING) AS BOOLEAN

Return value

If the operation succeeds, the return value is TRUE. If the operation fails, the return value is FALSE.

Remarks

First you have to create an instance of the CRichEditOleCallback class and pass a pointer to it to the rich edit control using the SetOleCallback method.

DIM pRichEditOleCallback AS CRichEditOleCallback = CRichEditOleCallback
pRichEdit.SetOleCallback(@pRichEditOleCallback)

Then load the .rtf file using the LoadRtfFromResource method.

pRichEdit.LoadRtfFromResource(<resource name>, e.g. RTFILE)

Resource file 1 24 “..xml” RTFFILE RCDATA “.<title of the rtf file>.rtf”

SetFont

Sets the font used by a rich edit control.

FUNCTION SetFont (BYREF wszFaceName AS WSTRING, BYVAL ptsize AS LONG) AS HRESULT

Return value

If the operation succeeds, the return value is a nonzero value. If the operation fails, the return value is zero.

AddLF/AddCR/AddCRLF

Inserts a line feed, a carriage return or a carriage return and line feed at the cursor position or at the end of the text.

SUB AddLF (BYVAL atEnd AS BOOLEAN = FALSE)
SUB AddCR (BYVAL atEnd AS BOOLEAN = FALSE)
SUB AddCRLF (BYVAL atEnd AS BOOLEAN = FALSE)

SaveRtf

Saves the contents of the rich edit control to a file in rtf format.

FUNCTION SaveRtf (BYREF wszFilename AS WSTRING, BYVAL Overwrite AS BOOLEAN = FALSE, _
BYVAL dwFlagsAndAttributes AS DWORD = FILE_ATTRIBUTE_NORMAL) AS BOOLEAN

Return value

Boolean true on success or false on failure.

SaveRtfNoObjs

Saves the contents of the rich edit control to a file in rtf format with spaces in place of COM objects.

For parameters and return values see the SaveRtf method.

SaveSelRtf

Saves selection of the rich edit control to a file in rtf format.

For parameters and return values see the SaveRtf method.

SaveText

Saves the contents of the rich edit control in text format.

For parameters and return values see the SaveRtf method.

SaveSelText

Saves selection of the rich edit control in text format.

For parameters and return values see the SaveRtf method.

IsTextBold

Checks if the selected text or the word under the cursor is bolded.

FUNCTION IsTextBold () AS BOOLEAN

Return value

Boolean true (-1) or false (0).

IsTextItalic

Checks if the selected text or the word under the cursor is italicised.

FUNCTION IsTextItalic () AS BOOLEAN

Return value

Boolean true (-1) or false (0).

IsTextStrikeOut

Checks if the selected text or the word under the cursor is striked out.

FUNCTION IsTextStrikeOut () AS BOOLEAN

Return value

Boolean true (-1) or false (0).

IsTextUnderline

Checks if the selected text or the word under the cursor is underlined.

FUNCTION IsTextUnderline () AS BOOLEAN

Return value

Boolean true (-1) or false (0).

SetTextBold

Changes the selected text or word under the cursor to bold. If it is already set, it removes it.

SUB SetTextBold ()

SetTextItalic

Changes the selected text or word under the cursor to italic. If it is already set, it removes it.

SUB SetTextItalic ()

SetTextStrikeOut

Changes the selected text or word under the cursor to strike out. If it is already set, it removes it.

SUB SetTextStrikeOut ()

SetTextUnderline

Changes the selected text or word under the cursor to underline. If it is already set, it removes it.

SUB SetTextUderline ()

TextColor

Gets/sets the color of the selected text or the word under the cursor.

(GET) PROPERTY TextColor () AS COLORREF
(SET) PROPERTY TextColor (BYVAL crTxtColor AS COLORREF)

FUNCTION GetTextColor () AS COLORREF
FUNCTION SetTextColor (BYVAL crTxtColor AS COLORREF) AS BOOLEAN

Return value

(GET) The color of the selected text or the word under the cursor if there is not selection.

(SET) A boolean true (-1) or false (0).

Remarks

To select text programatically, use the SetSel method.

TextFontName

Gets/sets the font face name of the selected text or the word under the cursor if there is not selection.

(GET) PROPERTY TextFontName () AS DWSTRING
(SET) PROPERTY TextFontName (BYREF wszFaceName AS WSTRING)

FUNCTION GetTextFontName () AS DWSTRING
FUNCTION SetTextFontName (BYREF wszFaceName AS WSTRING) AS BOOLEAN

Return value

(GET) The font face name.

(SET) A boolean true (-1) or false (0).

Remarks

To select text programatically, use the SetSel method.

TextHeight

Gets/sets the height of the selected text or the word under the cursor.

(GET) PROPERTY TextHeight () AS LONG
(SET) PROPERTY TextHeight (BYVAL ptSize AS LONG)

FUNCTION GetTextHeight () AS LONG
FUNCTION SetTextHeight (BYVAL ptSize AS LONG) AS BOOLEAN

Return value

(GET) The height of the selected text or the word under the cursor if there is not selection.

Remarks

To select text programatically, use the SetSel method.

TextOffset

Gets/sets the offset of the selected text or the word under the cursor.

(GET) PROPERTY TextOffset () AS LONG
(SET) PROPERTY TextOffset (BYVAL offset AS LONG)

FUNCTION GetTextOffset () AS LONG
FUNCTION SetTextOffset (BYVAL offset AS LONG) AS BOOLEAN

Return value

(GET) The offset of the selected text or the word under the cursor if there is not selection.

(SET) A boollean true (-1) or false (0).

Remarks

This property converts the pixels to twips internally.

To select text programatically, use the SetSel method.

GetDocumentInterface

Retrieves a pointer to the ITextDocument2 interface.

FUNCTION GetDocumentInterface () AS ITextDocument2 PTR

Return value

A pointer to the ITextDocument2 interface. When you have finished to use it, you must release it calling its Release method.

Usage example

DIM pTextDoc AS ITExtDocument2 PTR
pTextDoc = pRichEdit.GetDocumentInterface
...
...
' // Release the pointer
IUnknown_Release(pTextDoc)

AttachMsgFilter

Attaches a new message filter to the edit instance. All window messages that the edit instance receives are forwarded to the message filter.

FUNCTION AttachMsgFilter (BYVAL pFilter AS IUnknown PTR) AS HRESULT

Return value

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code.

Remarks

The message filter must be bound to the document before it can be used.

BeginEditCollection

Turns on edit collection (also called undo grouping).

FUNCTION BeginEditCollection () AS HRESULT

Return value

If the method succeeds, it returns S_OK. If the method fails, it returns one of the following COM error codes: S_FALSE (undo is not enabled), E_NOTIMPL (this method is not implemented).

EndEditCollection

Turns off edit collection (also called undo grouping).

FUNCTION EndEditCollection () AS HRESULT

Return value

If the method succeeds, it returns S_OK. If the method fails, it returns E_NOTIMPL (this method is not implemented).

Remarks

The screen is unfrozen unless the freeze count is nonzero.

CaretType

Gets/sets the caret type.

(GET) PROPERTY CaretType () AS LONG
(SET) PROPERTY CaretType (BYVAL Value AS LONG) AS HRESULT

FUNCTION GetCaretType () AS LONG
FUNCTION SetCaretType (BYVAL Value AS LONG) AS HRESULT

Result code

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code. Call GetErrorInfo to get information about the result.

CheckTextLimit

Checks whether the number of characters to be added would exceed the maximum text limit.

FUNCTION CheckTextLimit (BYVAL cch AS LONG) AS LONG

Return value

The number of characters that exceed the maximum text limit. This parameter is 0 if the number of characters does not exceed the limit.

Result code

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code.

DefaultTabStop

Gets/sets the default tab width. Default value is 36.0 points, that is, 0.5 inches.

(GET) PROPERTY DefaultTabStop () AS SINGLE
(SET) PROPERTY DefaultTabStop (BYVAL Value AS SINGLE)

FUNCTION GetDefaultTabStop () AS SINGLE
FUNCTION SetDefaultTabStop (BYVAL Value AS SINGLE = 36.0) AS HRESULT

Result code

If the method succeeds it returns S_OK. If the method fails, it returns E_INVALIDARG (invalid argument) or E_OUTOFMEMORY (insufficient memory.).

Remarks

The default tab width is used whenever no tab exists beyond the current display position. The default width is given in floating-point points.

DocumentFont

Gets/sets a pointer to the ITextFont2 interface.

(GET) PROPERTY DocumentFont () AS ITextFont2 PTR
(SET) PROPERTY DocumentFont (BYVAL pFont AS ITextFont2 PTR)

FUNCTION GetDocumentFont () AS ITextFont2 PTR
FUNCTION SetDocumentFont (BYVAL pFont AS ITextFont2 PTR) AS HRESULT

Return value

A pointer to the ITextFont2 interface. When you have finished to use it, you must release it calling its Release method.

Usage example

DIM pTextFont AS ITExtFont2 PTR
pTextFont = pRichEdit.DocumentFont
--or--
pTextFont = pRichEdit.GetDocumentFont
...
...
' // Release the pointer
IUnknown_Release(pTextFont)

DocumentPara

Gets/sets an object that provides the default paragraph format information for this instance of the Text Object Model (TOM) engine.

(GET) PROPERTY DocumentPara () AS ITextPara2 PTR
(SET) PROPERTY DocumentPara (BYVAL pTextPara AS ITextPara2 PTR)

FUNCTION GetDocumentPara () AS ITextPara2 PTR
FUNCTION SetDocumentPara (BYVAL pTextPara AS ITextPara2 PTR) AS HRESULT

Return value

A pointer to the ITextPara2 interface. When you have finished to use it, you must release it calling its Release method.

EastAsianFlags

Gets the East Asian flags.

FUNCTION EastAsianFlags () AS LONG
FUNCTION GetEastAsianFlags () AS LONG

Return value

The East Asian flags. This parameter can be a combination of the following values.

Result code

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code.

Freeze

Increments the freeze count.

FUNCTION Freeze () AS LONG

Return value

The updated freeze count.

Result code

If the Freeze count is nonzero, it returns S_OK. If the Freeze count is zero, it returns FALSE.

Remarks

If the freeze count is nonzero, screen updating is disabled. This allows a sequence of editing operations to be performed without the performance loss and flicker of screen updating. To decrement the freeze count, call the Unfreeze method.

Unfreeze

Decrements the freeze count.

FUNCTION Unfreeze () AS LONG

Return value

The updated freeze count.

Result code

If the freeze count is zero, the method returns S_OK. If the method fails, it returns S_FALSE, indicating that the freeze count is nonzero.

Remarks

If the freeze count goes to zero, screen updating is enabled. This method cannot decrement the count below zero, and no error occurs if it is executed with a zero freeze count.

Note, if edit collection is active, screen updating is suppressed, even if the freeze count is zero.

GetCallManager

Gets the call manager.

FUNCTION GetCallManager () AS IUnknown PTR

Return value

Gets the call manager.

Result code

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code.

Remarks

The call manager object is opaque to the caller. The Text Object Model (TOM) engine uses the object to handle internal notifications for particular scenarios.

ReleaseCallManager

Releases the call manager.

FUNCTION ReleaseCallManager (BYVAL pVoid AS IUnknown PTR) AS HRESULT

Return value

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code.

GetDisplays

Gets the displays collection for this Text Object Model (TOM) engine instance.

FUNCTION GetDisplays () AS ITextDisplays PTR

Return value

A pointer to the displays collection.

Result code

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code.

Remarks

The rich edit control doesn’t implement this method.

Range

Retrieves a new text range for the active story of the document.

FUNCTION Range (BYVAL cpActive AS LONG = 0, BYVAL cpAnchor AS LONG = 0) AS ITextRange2 PTR

Return value

A ITextRange2 pointer to the specified text range.

Result code

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code. Call GetErrorInfo to get information about the result.

RangeFromPoint

Retrieves the degenerate range at (or nearest to) a particular point on the screen.

FUNCTION RangeFromPoint (BYVAL x AS LONG, BYVAL y AS LONG, BYVAL nType AS LONG) AS ITextRange2 PTR

Return value

The text range that corresponds to the specified point.

Result code

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code.

GetStoryRanges

Gets the story collection object used to enumerate the stories in a document.

FUNCTION GetStoryRanges () AS ITextStoryRanges PTR

Return value

The ITextStoryRanges pointer. It can be null if there is only one story in this document.

Result code

If the method succeeds, it returns S_OK. If the method fails, it returns E_NOTIMPL (not implemented; only one story in this document).

GetStoryRanges2

Gets an object for enumerating the stories in a document.

FUNCTION GetStoryRanges2 () AS ITextStoryRanges2 PTR

Return value

The object for enumerating stories.

Result code

If the method succeeds, it returns S_OK. If the method fails, it returns E_NOTIMPL (not implemented; only one story in this document).

Remarks

Call this method only if the GetStoryCount method returns a value that is greater than one.

Saved

Gets/sets a value that indicates whether changes have been made since the file was last saved.

(GET) PROPERTY Saved () AS BOOLEAN
(SET) PROPERTY Saved (BYVAL value AS BOOLEAN)

FUNCTION GetSaved () AS BOOLEAN
FUNCTION SetSaved (BYVAL value AS BOOLEAN) AS HRESULT

Return value

(GET) The value tomTrue if no changes have been made since the file was last saved, or the value tomFalse if there are unsaved changes.

Result code

(SET) If the method succeeds, it returns S_OK. If the method fails, it returns E_INVALIDARG (invalid argument). Call GetErrorInfo to get information about the result.

Selection

Gets the active selection.

PRIVATE FUNCTION Selection () AS ITextSelection PTR
PRIVATE FUNCTION GetSelection () AS ITextSelection PTR

Return value

The active selection. It will be null if there is not active selection.

Result code

If the method succeeds, it returns S_OK. If there is not active selection, it returns S_FALSE. Call GetErrorInfo to get information about the result.

Selection2

Gets the active selection.

PRIVATE FUNCTION Selection2 () AS ITextSelection PTR
PRIVATE FUNCTION GetSelection2 () AS ITextSelection PTR

Return value

The active selection. It will be NULL if the rich edit control is not in-place active.

Result code

If the method succeeds, it returns S_OK. If there is not active selection, it returns S_FALSE. Call GetErrorInfo to get information about the result.

StoryCount

Gets the number of stories in the document.

DECLARE FUNCTION StoryCount () AS LONG
DECLARE FUNCTION GetStoryCount () AS LONG

Return value

The number of stories in the document.

Result code

If the method succeeds, it returns S_OK. Call GetErrorInfo to get information about the result.

GetClientRect

Retrieves the client rectangle of the rich edit control.

FUNCTION GetClientRect (BYVAL nType AS LONG, BYREF Left AS LONG, BYREF Top AS LONG,_
   BYREF Right AS LONG, BYREF Bottom AS LONG) AS HRESULT
FUNCTION GetClientRect (BYVAL nType AS LONG) AS .RECT

Return value

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code.

The second overlapped structure returns a RECT structure.

EffectColor

Retrieves the color used for special text attributes.

(GET) PROPERTY EffectColor (BYVAL Index AS LONG) AS ULONG
(SET) PROPERTY EffectColor (BYVAL Index AS LONG, BYVAL Value AS ULONG)

FUNCTION GetEffectColor (BYVAL Index AS LONG) AS ULONG
FUNCTION SetEffectColor (BYVAL Index AS LONG, BYVAL Value AS ULONG) AS HRESULT

Return value

(GET) The color that corresponds to the specified index.

Result code

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code.

Remarks

The first 16 index values are for special underline colors. If an index between 1 and 16 hasn’t been defined by a call to the SetEffectColor method, GetEffectColor returns the corresponding Microsoft Word default color.

GetGenerator

Gets the name of the Text Object Model (TOM) engine.

FUNCTION GetGenerator () AS DWSTRING

Return value

The name of the TOM engine.

Result code

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code.

GetImmContext

Gets the Input Method Manager (IMM) input context from the Text Object Model (TOM) host.

FUNCTION GetImmContext () AS __int64

Return value

The IMM input context.

Result code

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code.

ReleaseImmContext

Releases an Input Method Manager (IMM) input context.

FUNCTION ReleaseImmContext (BYVAL Context AS __int64) AS HRESULT

Return value

The IMM input context.

Result code

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code.

GetPreferredFont

Retrieves the preferred font for a particular character repertoire and character position.

PRIVATE FUNCTION GetPreferredFont (BYVAL cp AS LONG, BYVAL CharRep AS LONG, _
   BYVAL nOptions AS LONG, BYVAL curCharRep AS LONG, BYVAL curFontSize AS LONG, _
   BYVAL fontName AS AFX_BSTR PTR, BYREF PitchAndFamily AS LONG, BYREF NewFontSize AS LONG) AS HRESULT

Return value

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code.

GetProperty

Retrieves the value of a property.

FUNCTION GetProperty (BYVAL nType AS LONG) AS LONG

Return value

The value of the property.

Result code

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code. Call GetErrorInfo to get information about the result.

SetProperty

Specifies a new value for a property.

FUNCTION SetProperty (BYVAL nType AS LONG, BYVAL Value AS LONG) AS HRESULT

Return value

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code. Call GetErrorInfo to get information about the result.

GetStory

Retrieves the story that corresponds to a particular index.

FUNCTION GetStory (BYVAl Index AS LONG) AS ITextStory PTR

Return value

A pointer to the ITextStory interface.

Result code

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code.

ActiveStory

Gets/sets the active story; that is, the story that receives keyboard and mouse input.

(GET) PROPERTY ActiveStory () AS ITextStory PTR
(SET) PROPERTY ActiveStory (BYVAL pStory AS ITextStory PTR)

FUNCTION GetActiveStory () AS ITextStory PTR
FUNCTION SetActiveStory (BYVAL pStory AS ITextStory PTR) AS HRESULT

Return value

A pointer to the ITextStory interface of the active story.

Result code

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code.

MainStory

Gets the main story.

FUNCTION MainStory () AS ITextStory PTR
FUNCTION GetMainStory (BYVAL pStory AS ITextStory PTR) AS HRESULT

Return value

A pointer to the ITextStory interface of the main story.

Result code

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code.

NewStory

Not implemented. Gets a new story.

FUNCTION NewStory () AS ITextStory PTR
FUNCTION GetNewStory (BYVAL pStory AS ITextStory PTR) AS HRESULT

Return value

A pointer to the ITextStory interface of the new story.

Result code

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code.

GetStrings

Gets a collection of rich-text strings.

FUNCTION GetStrings () AS ITextStrings PTR

Return value

A pointer to the collection of rich-text strings.

Result code

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code.

Remarks

The collection is useful for manipulating rich text, particularly for transforming mathematical text from linear to built-up form, or vice versa.

GetWindow

Gets the handle of the window that the Text Object Model (TOM) engine is using to display output.

FUNCTION FUNCTION GetWindow () AS __int64

Return value

The handle of the window that the TOM engine is using.

Result code

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code.

SetIMEInProgress

Sets the state of the Input Method Editor (IME) in-progress flag.

FUNCTION SetIMEInProgress (BYVAL Value AS LONG) AS HRESULT

Return value

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code.

MathProperties

Gets/sets the math properties for the document.

PROPERTY MathProperties () AS LONG
PROPERTY MathProperties (BYVAL nOptions AS LONG, BYVAL Mask AS LONG)

FUNCTION GetMathProperties () AS LONG
FUNCTION SetMathProperties (BYVAL Options AS LONG, BYVAL Mask AS LONG) AS HRESULT

Return value

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code.

NotificationMode

Gets/sets the notification mode.

(GET) PROPERTY NotificationMode () AS LONG
(SET) PROPERTY NotificationMode (BYVAL Value AS LONG)

FUNCTION GetNotificationMode () AS LONG
FUNCTION SetNotificationMode (BYVAL Value AS LONG) AS HRESULT

Return value

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code.

Notify

Notifies the Text Object Model (TOM) engine client of particular Input Method Editor (IME) events.

FUNCTION Notify (BYVAL nNotify AS LONG) AS HRESULT

Return value

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code.

SysBeep

Generates a system beep.

FUNCTION SysBeep () AS HRESULT

Return value

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code.

Update

Updates the selection and caret.

FUNCTION Update (BYVAL Value AS LONG) AS HRESULT

Return value

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code.

UpdateWindow

Notifies the client that the view has changed and the client should update the view if the Text Object Model (TOM) engine is in-place active.

FUNCTION UpdateWindow () AS HRESULT

Return value

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code.